Versions Compared

Key

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

1. Introduction

This document briefly describes the Delft3d Delft-FEWS adapter.In order to use the adapter some knowledge of both Delft-FEWS and Delft3d Delft3D is required.

...

2. Directory structure

To minimise the number of choices that have to be made by the user, the Delft3D adapter expects a fixed set of directories and files. Roughly speaking: anything for which a reasonable default can be set, has been fixed. This means for example that the description of the export activities in the Delft-FEWS configuration files must use these directory and file names. The advantage is that there are much less opportunities for making mistakes (see the section on configuration errors).

The following directories and files are used. The directories are taken as subdirectories of the work directory that you give in the module configuration [file:\\]

Directory/file

Purpose

input

Contains all the files with timeseries and map stacks exported by Delft-FEWS

input/timeseries.xml

XML-file with (scalar) timeseries

input/map_<param>.xml

XML-file describing the map stacks with parameter "param" (see the documentation of the keywords)

stateInput

Contains all the files with the initial conditions and other static information that together constitute the "state" from which the computation must start

stateInput/export_states.xml

The XML-file describing the time of the state files.
(Export from the point of view of Delft-FEWS)

output/timeseries.xml

XML-file with the resulting (scalar) timeseries, to be imported by Delft-FEWS

output/<FEWS-param>.xml

XML-file describing the resulting map stacks with FEWS parameter "FEWS-param" (see the documentation of the keywords)

stateOutput

Contains all the files with the final results, useful as initial conditions.

stateOutput/import_states.xml

The XML-file describing the time of the final state files.
(Import from the point of view of Delft-FEWS)


3. Configuration file

The Delft3D adapter uses a fixed set of directories and files to do most of its work. Some items do have to be specified in the configuration file, as these may vary from application to application. This section describes the structure of the configuration file.

Below is an example of such a [file:\\]

<?xml version="1.0" encoding="UTF-8"?>

...

              xsi:schemaLocation="http://www.wldelft.nl/fews

              http://fews.wldelft.nl/schemas/version1.0/delft3DModel.xsdImage Removed">

       <general>

...

  • Delft3D-FLOW produces, in general, a series of restart files. Only the last one is made known to FEWS.
  • Delft3D-PART does not have initial conditions files or restart files.
  • Delft3D-WAQ produces a restart file at the end of the computation.
  • P.M.: Delft3D-WAVE

Wiki Markup
Note that to keep the interaction between the preadapter and the post adapter at a minimum (the preadapter handles the start and stop time for the computation and the post adapter needs to know the stop time to properly register the restart files), we use a small auxiliary file containing that information.\[[1]\|#_ftn1\]

...

Wiki Markup
\[[1]\|#_ftnref1\] Strictly speaking, for Delft3D-FLOW the time that we need is the time of the \_last_ restart file. This has not been implemented yet
 -- if you use the FLOW_TIME_RST keyword, this should not matter.