View Source

Note: the below page contains information on the old adapter for 3Di. A completely new adapter is available through the 3Di software developer. See all information at https://docs.3di.live/d_fews_3di_connector.html

Please note that for running 3Di subgrid from Delft-FEWS only a pre-adapter is needed (a post-adapter is not needed).

3Di pre-adapter

Model pre-adapter for running a 3Di subgrid model from Delft-FEWS.

For information about the 3Di model see:

https://publicwiki.deltares.nl/display/3Diusers/Home

http://www.3di.nu/

Usage: PreAdapter <xml pi run file pathname relative to current working directory>

Class name: nl.wldelft.fews3di.PreAdapter

Properties

mdu	(required)	Pathname of the MDU file to update. This should be either an absolute path or a path relative to the current working directory.

Notes for users

For all files that are written by this adapter, if the file to be written already exists, then it will be overwritten.
This program uses the information in the specified xml pi run file as input and uses this information to do the following actions:
1. Copy model template files:
  Everything from the model directory is copied to the workDir specified in the xml pi run file. The model directory is defined as the directory in which the MDU file is present.
2. Update MDU file in workDir:
  In the MDU file (the copy in the workDir) the following entries will be updated automatically (no tags needed):

StartDate	Start date of the model run, in the timeZone of the model.
StartTime	Start time of the model run, in the timeZone of the model.
NTimesteps	The number of timesteps for which the model should run. This uses the timestep "Dt" that is specified in the MDU file.

3. Convert input time series:
All pi time series .xml files (containing one or more scalar time series) that are exported from Delft-FEWS (listed in the xml pi run file as inputTimeSeriesFiles) are converted to .tim files. The .tim files are written in the workDir specified in the xml pi run file. For each time series a separate .tim file is created with a filename equal to <locationId>_0001.tim where <locationId> is the externalLocationId of the time series in Delft-FEWS.

System requirements

This program needs Java version 8 or higher.
This program needs the following Java libraries:
- castor-0.9.5.jar
- Delft_PI.jar
- Delft_PI_castor.jar
- Delft_Util.jar
- log4j-1.2.14.jar
- xercesImpl.jar

Configuration example

Please note that for running 3Di subgrid from Delft-FEWS only a pre-adapter is needed (a post-adapter is not needed). Example of a FEWS general adapter configuration that uses the 3Di adapter:

TODO