How to set up a DeltaShell Sobek-3 model in FEWS

Function:	Functionality to use FewsAdapter of DeltaShell and how to use them in your configuration
Where to Use?	General Adapter
Why to Use?	To be able to run a Sobek-3 model
Description:	Description and examples of adapter configuration to use a Sobek-3 (DeltaShell) model in FEWS.
Available since:	Delft-FEWS 201201

General

Installation requirements

It is not required to have DeltaShell SOBEK installed at the PC as it is possible to embed the binaries of SOBEK in to the FEWS configuration. There is a special build available that can be simple unzipped in the FEWS Modules directory, e.g. <Region>\Modules\Sobek3\plugins and <Region>\Modules\Sobek3\release.

There should a valid license to use Sobek-3, preferably including Terminal Server license (TS_OK).

Interaction between FEWS and Sobek

The adapter does not have any seperate configuration. All options and definitions are parsed through the General Adapter's PI-Run file. The desired output is completely defined in FEWS only and parsed to SOBEK.

Available time series

H boundary
Q boundary
lateral timeseries
wind speed and direction
concentration or Masses on bounds en lateral (e.g. Salinity, conc. and mass)
RTC Setpoint (interval, PID)
struc crest level
struc crest width
struc gate level
struc pump capacity
rainfall
evaporation

Delft-FEWS Configuration

Definition of Sobek locations from Shape files

Nodes and Reach segments

SOBEK-3 has an option to export the model network to shape files, which can be easily imported into FEWS as locations. Sobek exports a seperate file for node and line objects, e.g.
*fews_ds_Lauwersmeermodel_line_data_items.shp
*fews_ds_Lauwersmeermodel_node_data_items.shp

The shape files have the TYPE property in the associated DBF file. The possible types are (case sensitive):

grid_point
ObservationPoint
HBoundary
QBoundary
Weir
Pump
Bridge
Culvert
LateralSource
reach_segment

Example configuration in LocationSets.xml:

<locationSet id="DS_LWMl">
  <esriShapeFile>
    <file>fews_ds_Lauwersmeermodel_line_data_items</file>
    <geoDatum>Rijks Driehoekstelsel</geoDatum>
    <charset>Cp850</charset>
    <id>DS_LWM_%ID%</id>
    <name>%ID% - %NAME%</name>
    <description>Deltashell sobek3 testmodel</description>
    <x>%X_CENTRE%</x>
    <y>%Y_CENTRE%</y>
    <attribute id="SOBEK_ID">
      <text>%ID%</text>
    </attribute>
    <attribute id="SOBEK_PARENTID">
      <text>%TYPE%</text>
    </attribute>
    <attribute id="SOBEK_MODEL">
      <text>LWM</text>
    </attribute>
  </esriShapeFile>
</locationSet>
<locationSet id="DS_LWM_reachseg">
  <locationSetId>DS_LWMl</locationSetId>
</locationSet>
<locationSet id="DS_LWMn">
  <esriShapeFile>
    <file>fews_ds_Lauwersmeermodel_node_data_items</file>
    <geoDatum>Rijks Driehoekstelsel</geoDatum>
    <charset>Cp850</charset>
    <id>DS_LWM_%ID%</id>
    <name>%ID% - %NAME%</name>
    <description>Deltashell sobek3 testmodel</description>
    <x>%X%</x>
    <y>%Y%</y>
    <attribute id="SOBEK_ID">
      <text>%ID%</text>
    </attribute>
    <attribute id="SOBEK_PARENTID">
      <text>%TYPE%</text>
    </attribute>
    <attribute id="SOBEK_MODEL">
      <text>LWM</text>
    </attribute>
  </esriShapeFile>
</locationSet>
<locationSet id="DS_LWM_Qbnd">
  <locationSetId>DS_LWMn</locationSetId>
  <constraints>
    <attributeTextEquals id="SOBEK_PARENTID" equals="QBoundary"/>
  </constraints>
</locationSet>
<locationSet id="DS_LWM_ow">
  <locationSetId>DS_LWMn</locationSetId>
  <constraints>
    <anyValid>
      <attributeTextEquals id="SOBEK_PARENTID" equals="grid_point"/>
      <attributeTextEquals id="SOBEK_PARENTID" equals="HBoundary"/>
      <attributeTextEquals id="SOBEK_PARENTID" equals="QBoundary"/>
    </anyValid>
  </constraints>
</locationSet>
<locationSet id="DS_LWM_struc">
  <locationSetId>DS_LWMn</locationSetId>
  <constraints>
    <anyValid>
      <attributeTextEquals id="SOBEK_PARENTID" equals="Weir"/>
      <attributeTextEquals id="SOBEK_PARENTID" equals="Pump"/>
      <attributeTextEquals id="SOBEK_PARENTID" equals="Bridge"/>
    </anyValid>
  </constraints>
</locationSet>

Longitudinal profiles

It is possible to define longitudinal profiles in SOBEK which can also be directly exported to a FEWS branch definition. The simulation results can also be directly derived from SOBEK.

Maps

will be available for 2D only, which is currently still not in SOBEK-3

General Adapter

PI run file

All possible options are defined the PI run file that FEWS provides to the Adapter. The options are:

option	description	required	default	example
deltaShellProjectFile	..	yes	-	%ROOT_DIR%\DSModel\lauwersmeer.dsproj
model	..	yes	-	Lauwersmeermodel
piTimeSeriesAsBin	option to write output to binairy PI files to allow for better performance on large output time series	no	false	true
saveResultsInCopyOfProject	This option is available for debug purpose. It saves always a copy of the simulation to "Copy of <project>"	no	false	true
workDir	Directory where to run the simulation	no	%TEMP% directory	="%ROOT_DIR%/Work

Example of PI Run configuration

<exportRunFileActivity>
  <exportFile>pi-run.xml</exportFile>
  <properties>
    <string key="deltaShellProjectFile" value="%ROOT_DIR%\DSModel\lauwersmeer.dsproj"/>
    <string key="model" value="Lauwersmeermodel"/>
    <string key="piTimeSeriesAsBin" value="bin"/>
    <string key="saveResultsInCopyOfProject" value="true"/>
    <string key="workDir" value="%ROOT_DIR%/Work"/>
  </properties>
</exportRunFileActivity>

Id Maps

Sobek expects the parameters to be in NetCDF standard IDs.

item in model	Sobek parameter id	Sobek module
H boundary	water_level	1D flow
Q boundary	water_discharge	1D flow
laterals	water_discharge	1D flow
wind speed	wind_speed	1D flow
wind direction	wind_direction	1D flow

to do:

concentration or Masses on bounds en lateral (e.g. Salinity, conc. and mass)
RTC Setpoint (interval, PID)
struc crest level
struc crest width
struc gate level
struc pump capacity
rainfall
evaporation

Page tree

Contents

General

Installation requirements

Interaction between FEWS and Sobek

Available time series

Delft-FEWS Configuration

Definition of Sobek locations from Shape files

Nodes and Reach segments

Longitudinal profiles

Maps

General Adapter

PI run file

Id Maps

Input series to Sobek

Output series from Sobek

State files

Diagnostics

Possible messages

Miscellaneous

Performance

How to run ensembles