...
Each section will now be described in more detail.
2.1 Section: <general>
In the <general> section the following options can be specified:
...
- Delft3D-FLOW requires the name of the file (*.grd) that defines the grid for the meteorological data. It is written in the header of the file with air pressure and so on.
- Delft3D-WAQ requires the name of the LGRID and CCO files, so that the segment function files can be written properly. This information is needed by the postadapter as well, in order to export the results on a grid. To avoid duplication, the information is given in the general section.
2.2 Section: <preAdapter>
The <preAdapter> section contains one keyword only, the name of the timeseries (found in the timeseries XML file exported by Delft-FEWS) that is to be used as to determine the time frame of the simulation.
...
The name of the timeseries is to be formed in this way: "external name of the parameter/external name of the location". For instance: if the external parameter name is "H" and the location is "Southern boundary", then the name for that time series is: "H/Southern boundary".
2.3 Section: <postAdapter>
The section <postAdapter> describes the actions to be taken after completion of the model run. Rather than blindly export all the results from the model run to Delft-FEWS and let it pick up the timeseries and map stacks of interest, the adapter exports only those timeseries and map stacks described in this section.
...
| Code Block |
|---|
<map parameter="Mean wave direction" layer="1" fewsParameter="Wave.direction.mean.ext" fewsLocation="Guanabara.wave.ext"/> <map parameter="Mean wave period" layer="1" fewsParameter="Wave.period.mean.ext" fewsLocation="Guanabara.wave.ext"/> <map parameter="Peak wave direction" layer="1" fewsParameter="Wave.direction.peak.ext" fewsLocation="Guanabara.wave.ext"/> <map parameter="Peak wave period" layer="1" fewsParameter="Wave.period.peak.ext" fewsLocation="Guanabara.wave.ext"/> <map parameter="Sign.wave height" layer="1" fewsParameter="Wave.sign.height.ext" fewsLocation="Guanabara.wave.ext"/> |
3. Template files and keywords
In the table below the various keywords are explained. It is important to note that these keywords are filled whenever they are encountered in a template file – the keywords are not associated with a particular type of file. The format for the keywords and any arguments there may be is as follows:
$(keyword: argument1, argument2, ...)
...
(Technical note: the entire text from the opening "$(" to the trailing ")" is replaced, without a trailing new line, by whatever the contents should be. The arguments should not contain commas parenthesis and there should be at least one space after the comma. This syntax makes it easy to implement the template mechanism.)
Keyword | Description |
|---|---|
FLOW_TIME_START | Start of the simulation (format in accordance with Delft3D-FLOW). |
FLOW_TIME_STOP | Stop of the simulation (format in accordance with Delft3D-FLOW) |
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). |
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:
|
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). |
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:
|
PART_RUNID | The run ID for the Delft3D-PART computation (used in the filename.dat file) |
PART_TIMESERIES | Placeholder to fill in the timeseries in the PART format, similar to the WAQ and FLOW timeseries keywords. |
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 |
4. Configuration errors
The adapter checks for the following types of errors:
- Are any of the timeseries and map stacks found in the input directory not used in the input for the Delft3D module? (This would mean some timeseries was forgotten in the template files.)
- Are all the timeseries and map stacks as encountered in the template files indeed available from the export by Delft-FEWS? If not, the proper data can not be filled in in the files and the computation can not run properly.
- Do all timeseries filled in in a particular table have the same start and stop time and the same time step? (The adapter does not attempt to correct any mismatch – this should be done via the Delft-FEWS configuration)
5. Technical documentation
This section describes the actual implementation of the adapter. It is meant mainly to help the implementors.
...