Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Keyword

Description

FLOW_TIME_START

Start of the simulation (format in accordance with Delft3D-FLOW).
(This is actually the time in minutes since the reference time, found in the mdf-file)

FLOW_TIME_STOP

Stop of the simulation (format in accordance with Delft3D-FLOW)
(Ditto as the start time)

FLOW_TIME_RST

Duration of the simulation – useful for setting the time interval of writing the restart files so that only one restart file is written at the end of the simulation.

FLOW_TIMESERIES

Placeholder to fill in the timeseries in the so-called tim format (only the time and data, not the header).
The keyword should be followed by the names of all timeseries that should be filled in there, separated by a comma and one or more spaces:

$(FLOW_TIMESERIES: h/bound-1 salinity/bound-1, temperature/bound-1)

(Despite the fact that the "tim" format is used more widely than just FLOW, there are some specifics involved.)

FLOW_MAPSTACK

Placeholder for the name of the file that will hold the scalar field data (as found in the map stack files). It should be followed by the name of the parameter:

$(FLOW_MAPSTACK: pressure)

Then:

  • The string "FLOW_MAPSTACK pressure" is replaced by "pressure.dat"
  • The file "pressure.dat" contains the map stacks in the format proper to Delft3D-FLOW
  • The XML-file "map_pressure.xml" in the input directory contains the details: which ASCII files and so on.
WAVE_TIMEFRAME

  Placeholder to fill values for TimePoint from start time to end time with specified increment.  Example:

$(WAVE_TIMEFRAME: 60, USE_WATERLEVEL_FLOW, USE_CURRENTS_FLOW)

  • TimeStep in this case is 60
  • (optional):  USE_WATERLEVEL_FLOW: use water levels from (offline) FLOW simulation
  • (optional):  USE_CURRENTS_FLOW:  use current information from (offline) FLOW simulation

WAQ_TIME_START

Start of the simulation (format in accordance with Delft3D-WAQ/ECO: yyyy/mm/dd-hh:mm:ss)

WAQ_TIME_STOP

Stop of the simulation (format in accordance with Delft3D-WAQ/ECO: yyyy/mm/dd-hh:mm:ss)

WAQ_TIMESERIES

Placeholder to fill in the timeseries in the WAQ /ECO format (only the time and data, not the header).
The keyword should be followed by the names of all timeseries that should be filled in there, separated by spaces:

$(WAQ_TIMESERIES: salinity/bound-1, temperature/bound-1)

WAQ_MAPSTACK

Placeholder for the name of the file that will hold the scalar field data (as found in the map stack files). It should be followed by the name of the parameter:

$(WAQ_MAPSTACK: windvel)

Then:

  • The string "WAQ_MAPSTACK windvel" is replaced by "windvel.dat"
  • The file "windvel.dat" contains the map stacks in the format proper to Delft3D-WAQ/ECO
  • The XML-file "map_windvel.xml" in the input directory contains the details: which ASCII files and so on.

PART_RUNID

The run ID for the Delft3D-PART computation (used in the filename.dat file)

PART_TIME_START

Placeholder to fill in start time in PART format, similar to WAQ and FLOW keywords.

NOTE. PART requires the formating of the inp file to be very specific (incl. specific numbers of spaces/tabs before keywords.)
Make sure your model runs before you start changing properties. 

Also, all text following the keyword will be replace/removed by the adapter when substituting the keyword

PART_TIME_STOP

Placeholder to fill in end time in PART format, similar to WAQ and FLOW keywords.

NOTE. PART requires the formating of the inp file to be very specific (incl. specific numbers of spaces/tabs before keywords.)
Make sure your model runs before you start changing properties. 

Also, all text following the keyword will be replace/removed by the adapter when substituting the keyword

PART_TIMESERIES

Placeholder to fill in the timeseries in the PART format, similar to the WAQ and FLOW timeseries keywords. 
NOTE. This only works in the .inp file. Not in an.inc file
NOTE. this requires the number of timesteps to be added to the *.inp as well, see PART_NUMBER_BREAKPOINTS

PART_NUMBER_BREAKPOINTS

Placeholder to fill in the number of time steps required for the wind input in the *.inp file. 

Example usage:

;                            Wind_parameters
$(PART_NUMBER_BREAKPOINTS: Wind.speed/Spill_Location)
; dd hh mm ss        speed(m/s)   direction(degr.)
$(PART_TIMESERIES: Wind.speed/Spill_Location, Wind.dir/Spill_Location)

PART_TIMESERIES

Placeholder to fill in the timeseries in the PART format, similar to the WAQ and FLOW timeseries keywords.

PART_MAPSTACK

Placeholder to fill in mapstacks in the PART format.  Example:

^(PART_MAPSTACK: x_wind,m s-1)

PART_INIFILE

File name for the initial patch - the header information is to be written by Delft-FEWS. Example:

^(PART_INIFILE: patch.ini)

PART_SHAPEFILE

File name for the shape file holding the polygon within which the particles will be released. Example:

^(PART_SHAPEFILE: patch.shp)

Use in combination with the keyword "PART_INIFILE". The coordinates will be appended to the ini-file as written by FEWS.

TEKAL_FILEAdditional keyword for PART. Example:

^(TEKAL_FILE: dispers.pol)

TEKAL_VALUES

Additional keyword for PART. Example:  

^(TEKAL_VALUES: lon.cleaned/obs1, lat.cleaned/obs1)

COUP_TIME_START

Start time of coupling (in seconds; time frame is that of Delft3D-FLOW)

COUP_TIME_STOP

Stop time of coupling (in seconds; ditto)

P.M.

Keywords specific to Delft3D-WAVE

For examples, see the MDF, MDW, BCC, WND, BND and INP files attached to this WiKi page.

...