...
The following directories and files are REQUIREDused, even if they are not required for the simulation. The directories are taken as subdirectories of the <rootDir> that you give in the configuration of the general adapter module. Some of these directories and files are only needed if state handling in the pre/post adapter is switched on.
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. This directory is only needed if state handling is switched on. |
stateInput/export_states.xml | The XML-file describing the time of the state files . |
output/timeseries_<runId>.xml | XML-file with the resulting (scalar) timeseries, to be imported by Delft-FEWS |
output/fewsParameter>.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. This directory is only needed if state handling is switched on. |
stateOutput/import_states.xml | The XML-file describing the time of the final state files . |
NetCDF run 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 as properties in the NetCDF run file (to be placed in the root of the <rootDir>), as these may vary from application to application. This section describes the properties that are needed.
...
module | (optional) | String indicating the type of Delft3D module to use. Can be "FLOW", "FLOW_FM", "WAQ", "ECO", "WAVE" or "PART". The module can also be specified as a runtime argument for the pre and post adapter, in which case it is not required in the netcdf run file. If the module is both present as a runtime argument and as a property in the netcdf run file, then the runtime argument overrules the property in the netcdf run file. |
|---|---|---|
run_id | (required) | String used to identify the template input file. The runId is used by the pre-adapter to determine which input files to scan for placeholder keywords. Relevant input files for each Delft3D module are listed below. |
template_directory | (required) | Template directory relative to rootDir. Directory containing the template files. These files are copied to the workDir by the model adapter prior to running a simulation. For each module only the files that correspond to that module and can contain keywords are copied from the template directory to the work directory. All other files (i.e. files that are not template files at all) should be present in the work directory in advance, as these files will not be copied over. |
state_file_id | (optional) | Prefix of the state file filename. This is only used for WAVE pre-adapter and WAVE post-adapter. The WAVE pre-adapter only processes state files that start with this prefix. This option is only used if state handling is switched on. |
auxiliary_grid_file | (optional) | Both Delft3D-FLOW and Delft3D-WAQ require the name of a grid file:
|
field_file_format | (optional) | Can be "old" (same behaviour as when not configured), "new", "CURVILINEAR" (same behaviour as for "new"). Control the format of the meteo and other field files. |
output_time_series_in_one_file | (optional) | Can be "true" or "false", default is false. Merges all output timeseries to one output XML file if true. |
online_morphology | (optional) | Can be "true" or "false", default is false. If true, then all *.dep files (morphology files) in the stateInput folder and subfolders thereof are copied to the workDir by the pre-adapter. This option is only used if state handling is switched on. |
restart_netcdf_file_subscript | (only required for module FLOW_FM) | The input restart file for Delft3D always has to be called "tri-rst.<run_id>.rst" where <run_id> is the value of the run_id property. The input restart file for FLOW_FM always has to be called "tri-rst.<run_id><restart_netcdf_file_subscript>" where <run_id> is the value of the run_id property and <restart_netcdf_file_subscript> is the value of the restart_netcdf_file_subscript property. Usually restart_netcdf_file_subscript = "_rst.nc"= "_rst.nc". This option is only used if state handling is switched on. |
initial_conditions_id | (optional) | Can be null. This is only used for FLOW pre-adapter and WAQ pre-adapter. This is ignored if there are multiple state files (from other modules) for online-coupled modules and/or domain decomposition. This option is only used if state handling is switched on. |
invert_time_stamp | (optional) | Can be "true" or "false", default is false. |
| input_spectra_file_to_convert | (optional) | Pathname of netcdf file with input spectra data that should be converted. This should be either an absolute path or a path relative to the workDir specified in the netcdf run file. This only works if the module property is set to "WAVE". Multiple spectra files can be specified by seperating them with a semicolon, only use a semicolon between spectra files and not at the end. For example: <string key="input_spectra_file_to_convert" value="%ROOT_DIR%/workDir/AGM_01.nc; %ROOT_DIR%/workDir/AGM_02.nc; %ROOT_DIR%/workDir/AGM_03.nc"/> |
...
- Currently the adapter assumes that the model always runs in time zone GMT (this will be improved in future).
- The same NetCDF run file can be used for both the pre-adapter and the post-adapter.
- The startTime and endTime from the NetCDF run file (which are determined by FEWS) are used as the time frame of the simulation.
- The modelDir option from the old delft3dModel adapter config file has been replaced with the property "template_directory". For each module only the files that correspond to that module and can contain keywords are copied from the template directory to the work directory. All other files (i.e. files that are not template files at all) should be present in the work directory in advance, as these files will not be copied over.
- The option useWaqMapFilesForInitialConditions from the old delft3dModel adapter config file is now assumed to be always true and cannot be configured, i.e. the new format is always used.
- The option to specify the "module" property as a runtime argument (see above) can be used to run the pre or post adapter multiple times with the same netcdf run info file but for different modules. For instance for a coupled FLOW-WAVE Delft3D run, need to configure five execute activities in sequence:
- pre adapter for module FLOW.
- pre adapter for module WAVE.
- FLOW-WAVE model.
- post adapter for module FLOW. post adapter for module WAVE.
- adapter for module WAVE.
- FLOW-WAVE model.
- post adapter for module FLOW.
- post adapter for module WAVE.
- The state handling in the pre and post adapter is automatically switched on if the input state description file stateInput/export_states.xml exists. If this file does not exist, then the state handling in the pre and post adapter is automatically switched off. Switching off the state handling in the pre and post adapter makes the configuration much easier. For more information, see 05 General Adapter Module#05GeneralAdapterModule-exportStateActivity and 05 General Adapter Module#05GeneralAdapterModule-importStateActivity
Commandline options
The first runtime argument for the pre or post adapter must be the root directory.
...
The use of pi state description files is optional in for both pre and post adapter. The example below shows a configuration of an exportStateActivity without using pi state description files (i.e. much simpler from a user's perspective):
...