Versions Compared

Key

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

JFlow General Adapter

1            JFlow

JFlow is a two-dimensional hydraulic model, which solves the St Venant Shallow Water Equations.  It makes use of GPU technology to complete simulations faster and more efficiently. 

...

Parameter

Description

Type

JflowExecutable

Full filepath of the JFlow executable, as installed on the host machine.

String

JflowDB

Name of the JFlow database, including file extension.            

The full filepath is not required if the module folder structure is maintained.

String

Device

Number of the GPU device, as machines may have multiple GPU cards.  Default is 0.

Integer

NumberFlowIDs

Number of flow boundaries.

Integer

FlowNames

Names of flow boundaries, separated by commas.

The name should match (1) the inflow ID in the JFlow model; and, (2) the external location ID of the xml timeseries exported from FEWS.  Any ID mapping takes place within FEWS.

String

NumberRainIDs

Number of rainfall inputs.

Integer

RainNames

Names of the rainfall inputs, separated by commas.

The name should match (1) the inflow ID in the JFlow model; and, (2) the external location ID of the xml timeseries exported from FEWS.  Any ID mapping takes place within FEWS.

String

OutputParameters

Output parameter types, separated by commas.  Commonly used options are: depth, hazard_index, velocity, water_level.

String

LocationID

LocationID that will be associated with the model results.

The value stated here should match the external ID in the FEWS ID mapping file.

String

 

Example .ini file:

 

[General]

ModelName=Jflow_test_model

JflowExecutable=C:\Program Files\JFLOW\JFLOW.exe

JflowDB=jflow_test.accdb

Device=0

[End]

[Flow inputs]

NumberFlowIDs=3

FlowNames=Flow_1, Flow_2, Flow_3

[End]

[Rain inputs]

NumberRainIDs=0

RainNames=0

[End]

[Required outputs]

OutputParameters=depth

LocationID=Jflow_test_map

[End]

...

The following sections contain examples of a module configuration file required to run JFlow through the JFlow adapter.  Notes for users are also given.

 

Code Block
languagexml
titleGeneral

...

collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<generalAdapterRun xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/generalAdapterRun.xsd">
            <general>
            <!-- general section to specify directories and id maps file -->
                        <description>JFlow fluvial test for the Don</description>
                        <rootDir>%REGION_HOME%/Modules/jflow/TestModel</rootDir>
                        <workDir>%ROOT_DIR%</workDir>
                        <exportDir>%ROOT_DIR%/input</exportDir>
                        <exportIdMap>Jflow_Export_Test</exportIdMap>
                        <importDir>%ROOT_DIR%/output</importDir>
                        <importIdMap>Jflow_Import_Test</importIdMap>
                        <dumpFileDir>$GA_DUMPFILEDIR$</dumpFileDir>
                        <dumpDir>%ROOT_DIR%</dumpDir>
                        <diagnosticFile>%ROOT_DIR%/diagnostics.xml</diagnosticFile>
            </general>
            <!-- burnInProfile - not currently used -->
            <activities>
                        <startUpActivities>
                        <!-- startUpActivities to remove files from previous runs -->
                                    <purgeActivity>
                                                <filter>%ROOT_DIR%/input/*.*</filter>
                                    </purgeActivity>
                                    <!--purgeActivity>
                                                <filter>%ROOT_DIR%/output/*.*</filter>
                                    </purgeActivity-->
                        </startUpActivities>

...

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

<generalAdapterRun xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/generalAdapterRun.xsd">

            <general>

            <!-- general section to specify directories and id maps file -->

                        <description>JFlow fluvial test for the Don</description>

                        <rootDir>%REGION_HOME%/Modules/jflow/TestModel</rootDir>

                        <workDir>%ROOT_DIR%</workDir>

                        <exportDir>%ROOT_DIR%/input</exportDir>

                        <exportIdMap>Jflow_Export_Test</exportIdMap>

                        <importDir>%ROOT_DIR%/output</importDir>

                        <importIdMap>Jflow_Import_Test</importIdMap>

                        <dumpFileDir>$GA_DUMPFILEDIR$</dumpFileDir>

                        <dumpDir>%ROOT_DIR%</dumpDir>

                        <diagnosticFile>%ROOT_DIR%/diagnostics.xml</diagnosticFile>

            </general>

            <!-- burnInProfile - not currently used -->

            <activities>

                        <startUpActivities>

                        <!-- startUpActivities to remove files from previous runs -->

                                    <purgeActivity>

                                                <filter>%ROOT_DIR%/input/*.*</filter>

                                    </purgeActivity>

                                    <!--purgeActivity>

                                                <filter>%ROOT_DIR%/output/*.*</filter>

                                    </purgeActivity-->

                        </startUpActivities>

...