Skip to content

Particle Reservoir Filter

Overview

Particle Reservoir Filter is a section in the PTM input where you set up particle filters. It is designed to modify the particle flux at a reservoir without changing hydrodynamic conditions by keeping particles from entering the specified waterbody.

Tables

Example

PARTICLE_RES_FILTER
NAME RES_NAME WATERBODY FILLIN FILE PATH
clfc_div_bbid clifton_court qext:dicu_div_bbid last ./filterOp.dss /HIST+FILTER/CLFC_DIV/FILTER_OP//IR-DECADE/DWR-BDO/
END

This is a special filter located at a reservoir directly connecting to a source flow. The PARTICLE_RES_FILTER table defines particle filters by giving them names, associating them to a reservoir and one of its directly connecting waterbodies, and setting up the passing efficiency (which could be a constant value or time-varying data in DSS).

Field Descriptions

  • NAME: Name assigned to the particle filter. This is the identifier of the filter used elsewhere to refer to the filter.
  • RES_NAME: The name of the reservoir to which the filter is applied.
  • WATERBODY: The type and ID of the waterbody to which the filter is attached.
  • FILLIN: Method for filling in data if the time step of the assigned series is coarser than the time step of the model. See fillin types.
  • FILE: DSS or text file in which data are stored. Use consistent case when referring to the same file. You may also enter the word constant if you would like to assign a constant value to the input (the value will be entered in the next column).
  • PATH: The path within the text or DSS file of the time series data. If you used the constant keyword in the Input File column, enter the value here. The stored variable is particle passing efficiency, a float value between 0 (block) and 1 (totally pass).

Similar to Particle Filter.