RTC module configuration file.
OBSOLETE. Still here for backwards compatibility. Remove after next release.
The components section includes all simulation components.
The rules section includes operating rules or controllers for defining the release of reservoir, structural settings of gates etc.
Triggers may activate or deactivate rules defined in the section above.
DEPRICATED
DEPRICATED
DEPRICATED
DEPRICATED
Accumulation of a time series over time
Arma error correction model
Mathematical expression
Post processing for computing gradients of simulated values
This is an implementation of the HBV-96 hydrological model. Note that the unit hydrograph is not included, but available separately.
Simplifications of the full dynamic, one-dimensional hydraulic model according to the kinematic wave, diffusive wave and inertial assumptions.
Modular, conceptual hydrological model with implicit time stepping scheme.
Reservoir with arbitrary number of inlets and outlets.
Test implementation of a compact reservoir class for simultaneous and sequential optimization mode
Lorent/Gevers hydrological model
not implemented yet
Unit delay operator for delaying a value by n times the time step of the model.
Unit hydrograph
sub-models for the modular setup of the hydrological model, the storage system contains a set of storage nodes and links and is solved with an implicit time stepping scheme
separates precipitation into snow and rainfall
potential evaporation
storage systems with storage nodes and links for setting up bucket models
total discharge [m3/s]
area [km2]
discharges from different storage nodes [m3/s]
evaporation correction factor, default = 1.0
temperature correction factor
monthly mean value of potential evaporation [mm/timestep]
monthly mean temperature [oC]
instantaneous temperature [oC]
instantaneous potential evaporation [mm/timestep]
smoothing parameter for switching between a linear ramp (D=0.0) and a sigmoid function (D=1.0)
rainfall correction factor [-], default is 1.0
snowfall correction factor [-], default is 1.0
temperature limit for snow and rainfall [oC]
temperature interval with a mixture of snow and rainfall [K]
precipitation [mm/timestep]
temperature [oC]
rainfall [mm/timestep]
snowfall [mm/timestep]
storage node
iteration stops after reaching this threshold
optional threshold after reaching the maximum number of iterations, writes a warning if reached, writes error otherwise
treat non-convergence related to the thresholds as error or not
number of evaluations of the Jacobian
number of function evaluations
residuum at last iteration step
constant area [km2], default is 1.0
unit volume [mm]
residuum [mm]
inflow as discharge [m3/s]
inflow as unit Volume [mm/timestep]
unit volume [mm], replaces the computes state
capillary flow, typically from GW (saturated upper zone - ground water) to UZ (unsaturated zone)
actual evaporation from unsaturated zone storage node
evaporation from interception storage node, typically VEG/P/UP (vegeration/paved interception)
GW Groundwater interaction with SW Surface water
percolation, typically from GW upper zone to GW lower zone), or from UP unpaved surface to UZ unsaturated zone
release above threshold from interception storage node, typically VEG/P/UP (uses relese above threshold link)
response from storage node, typically GW upper and GW lower zone storage nodes
sewer overflow (uses relese above threshold link)
soil runoff from UZ unsaturated zone to GW upper zone storage node
water treated via the WWTP, flows at a max rate of a constant max pump capacity. Uses water distribution constant link
water abstraction/distribution/consumption referenced to a constant demand (e.i. maxpump capacity). Uses water distribution constant link
water abstraction/distribution/consumption referenced to a variable demand (e.i. domestic or industrial water demands). Uses water distribution variable link)
NOT REFACTORED. melting and refreezing, typically used between SP (snow pack) and WC (water content) nodes
NOT REFACTORED. release from water content storage node (typically WC)
NOT REFACTORED. water consumption by domestic irrigation due to dry soil
Discharge as unit volume [mm/timestep]
Discharge [m3/s]
upstream node, typically SP (snow pack)
downstream node, typically WC (water content)
instanteneous temperature [oC]
area [km2]
degree day factor [mm/day]
refreezing factor [-]
smoothing factor, default = 0.05, more smoothing for higher value and vice versa
temperature limit for melting [oC]
upstream node, typically WC (water content)
auxiliary node with snow pack, typically SP (snow pack)
area [km2]
water holding capacity [-]
smoothing coefficient
upstream node, typically IC (interception)
potential evaporation [mm]
area [km2]
area [km2], default = 1.0
percentage of the flow which flows towards the bucket of interest. The permitted range is between 0 and 100
upper limit of (interception) storage node [mm]
smoothing factor
upstream node
downstream node
upstream node, source of water usually the drinking water treatment plant
downstream node which recieves the irrigation water
area [km2], default = 1.0
costant irrigation flux [mm/d]
Threshold of the downstream node under which irrigation is needed [mm]
smoothing factor
area [km2], default = 1.0
capacity of demand/abstraction [m3/s]
minimum abstraction level upstream [mm]. Default 0, till empty.
smoothing factor
upstream node, source of water abstraction/distribution (i.e. surface water/groundwater/sewerage)
downstream node collector of abstracted water. For instance drinking water treatment plant
area [km2], default = 1.0
minimum abstraction level upstream [mm]. Default 0, till empty.
smoothing factor
upstream node, source of water abstraction/distribution (i.e. surface water/groundwater/sewerage)
downstream node collector of abstracted water. For instance drinking water treatment plant
series of industrial or domestic water demands/abstractions [m3/s]
upstream node, can be GW groundwater or SW surface water
downstream node, can be GW groundwater or SW surface water
Ground water reaction coefficient
area [km2]
Ground water Conductivity [1/d]
Maximum groundwater flow [mm/d]
upstream node, typically SM (soil moisture)
area [1000 m2], default = 1.0
distance measure for smoothing the transitions [-]
field capacity [mm]
limit for potential evaporation [-]
upstream node, typically unsaturated zone (SM soil moisture)
optional downstream node, typically uper saturated zones (UZ upper zone storage). Required if capillary flow is used and SM and UZ are present in one storage system
infiltation into the unsaturated zone (fluzex into SM [m3/s])
area [km2]
parameter in soil routine [-]
field capacity [mm]
upstream node, typically GW upper zone
downstream node, typically UZ unsaturted zone
area [km2]
maximum value of capillary flow [mm/d]
field capacity [mm]
area [km2]
recession coefficient [1/d]
response box parameter [-], default = 0.0
upstream (release) node, typically UZ and/or LZ (upper/lower zone storages)
area [km2]
percolation [mm/d]
upstream node, typically UZ (upper zone storage)
downstream node, typically LZ (lower zone storage)
autoregression coefficient related to prior time step
observed data
simulated data
output-corrected data
optional multiplier
input variable
optional multiplier
input variable
gradient, dx = multiplier*(xNew-xOld)/dt
correction factor for EP
correction factor for rainfall
correction factor for snow
temperature limit for snow / rain [oC], normally close to 0
temperature interval with a mixture of snow / rain [oC]
degree day factor [mm/(oC*day)], varies normally between 1.5 and 4, 2 and 3.5 can be used in forested and open
landscape respectively
refreezing factor [-], about 0.05
water holding capacity [-], usually 0.1
temperature limit for melting [oC]
maximum interception storage
parameter in soil routine [-], usually between 1 and 6
maximum value of CF
temperature correction factor
field capacity [mm], between 50 and 500
limit for potential evapotranspiration [-], in the range between 0.3 and 1
response box parameter [-], usually between 1.0 and 2.0
catchment area [km2]
recession coefficient
recession coefficient [1/day]
percolation from upper to lower response box [mm/day], usually between 0 and 6
increment on lower zone storage [mm]
STILL NOT IMPLEMENTED
STILL NOT IMPLEMENTED
STILL NOT IMPLEMENTED
STILL NOT IMPLEMENTED
precipitation threshold [mm]
Time lag of input data [h]
recession coefficient 1
recession coefficient 2
degree day factor [mm/(oC*day)]
area [km2]
critical temperature (???) [oC]
critical temperature (???) [oC]
precipitation [mm]
temperature [oC]
rain contributing area [0,1]
temperature [oC]
runoff coefficient for rainfall [-]
runoff coefficient for snow melt [-]
snow storage of non-snow-covered areas [mm]
discharge [m3/s]
nStep optionally provides a delay with an arbitrary numer of time steps or sub time step, i.e. 1.5 time steps, if being used also specify the yFinal tag in the output options
The configuration of a multiple unit delay requires the configuration of a time series for each delay time step
optional result of the delay operator, identical to yVector[end] if the delay is a multiple of the time step, required in case of sub time steps
optional mean of input and outputs
optional sum of input and outputs
weights with triangular shape
user-defined weights
number of time steps
sum of all weight, if not equal to 1.0
user defined weights
definition of individual time series for vector with delays, configure one element less than weights defined above
definition of delay vector, configure one element less than weights defined above
result of unit hydrograph
"SI" or "Imperial" units
the level-storage relation is expected to be: a) strictly monotone, b) has a monotone 1st-order derivative (=area)
level-storage relation of the reservoir, level in [m] or [ft], storage in [m3] or [KCFS-hrs]
externalizes the level storage table to a parameter file, requires the two columns "level" and "storage"
level storage equation according to S = A0 + A1*FB ( + A2*FB^2 + ...)
tailwater as a function of the reservoir release only
tailwater equation according to TW = A + B*FB_downstream(t-1) + C*Q(t)^D, D is equal 1.0 by default if not provided
tidal influenced tailwater equation (works only in hindcast mode, use tailwater external with appropiate forecast of the tailwater in operational forecasting), TW = TWObs + A*(Q-QObs)
external tailwater table
external tailwater elevation from an external source or a previous calculation OUTSIDE of the reservoirCompact components
constant value for tailwater elevation
old formulation, will be removed in the future
new formulation, turbine effiency depends on head and turbine release, computation by 2D lookup
input time series
output time series
time series reference to forebay elevation of the downstream project, only required if B is non-zero
column Ids refering to the head [m] of each column
rows with turbine efficiency (related to the head coloumn) for a given flow
maximum flow for a given head (provided above)
forebay elevation [m above reference level] or [ft above sea level]
single or multiple inflow time series into the reservoir [m3/s] or [KCFS], data is expected to be complete and valid if provided
reservoir outflow [m3/s] or [KCFS], data is expected to be complete and valid
relative spill target (gets overruled by absolute spill target if available)
relative spill target as a percentage [0..100] of the total flow Q
relative spill target as a percentage [0..100] of the total flow Q
absolute spill target
absolute spill target [m3/s] or [KCFS]
absolute spill target [m3/s] or [KCFS]
optional miscellaneous flow (uncontrolled), will be zero by default [m3/s] or [KCFS] if no time series is supplied or if the time series includes NaN values
minimum generation constraint on aggregated turbine level [MW], primarly used as operational constraint
fixed minimum generation constraint on aggregated turbine level [MW], primarily used as physical constraint
maximum generation constraint on aggregated turbine level [MW], primarly used as operational constraint
fixed maximum generation constraint on aggregated turbine level [MW], primarly used as physical constraint
maximum generation constraint on aggregated turbine level [m3/s] or [KCFS], primarily used as operational constraint
fixed maximum generation constraint on aggregated turbine level [m3/s] or [KCFS], primarily used as physical constraint
optional time series with the unit outage factor [0-1], it reduces the (physical) constraints PXValue and QTXValue (NO impact on PX, QTX)
storage [m3] or [KCFS-hrs], this is the system state needed in the state file
forebay elevation [m above reference level] or [ft above sea level]
reservoir outflow [m3/s] or [KCFS]
reservoir inflow [m3/s] or [KCFS]
turbine flow [m3/s] or [KCFS]
maximum turbine flow [m3/s] or [KCFS]
spillage [m3/s] or [KCFS]
relative spillage [0..100]
miscellaneous flow [m3/s] or [KCFS]
deviation from spill target [m3/s] or [KCFS]
tailwater elevation [m above reference level] or [ft above sea level]
head [m] or [ft]
power generation [MW]
maximum power generation [MW]
residuum of mass balance (in simultaneous mode) [m3/s] or [KCFS]
Time integration scheme for the network components
Time weighting coefficient for the semi-implicit theta schema: 0 is equal to a full weight on the old time step, 1 represents a full weight on new time step. The coefficient is not used in the fully explicit or implicit schemas. The permitted range is between 0.5 and 1.0.
Storage characteristics of the reservoir: The storage S as a function of the water level h can be provided as a table or formula.
Controlled outlet, release can be defined by external input or rule
Uncontrolled outlet, the release is a function of the water level h in the reservoir
Tailwater rating curve
Reference to timeseries in data configuration
Contains references to the output timeseries in the data configuration
arbitrary number of layers
arbitrary number of neurons within one of the layers
transfer function: sigmoid, linear etc.
reference to time series ID
Supply neuron id! This can be any neuron in the network, also the neuron itself and neurons in the following layers. In this case, the output of the last time step is used -> recurrent network
result of the transfer function
result of the summation of weighted input (intermediate result)
Storage nodes
Flow branches
Hydraulic structures
number of evaluations of the Jacobian
number of function evaluations
residuum at last iteration step, 0.5*sum(SQR(ri))
Simple rule with constant value
Date lookup table, output y is a function of date and an input value x, the interpolation on the date / value axis can be BLOCK or LINEAR, the number of records should be constant for each date record
Deadband threshold, yNew will become yOld, if the change yNew-yOld is smaller than the threshold value
Dedicated rule for the control of Bielersee, Canton Bern, CH
Dedicated rule for the control of Thunersee, Canton Bern, CH
mathematical expression
Guide band rule, output get 0 if input less equal xMin, 1 if input greater equal xMax, linear interpolation otherwise xMin and xMax can be a function of date, main application in combination with a relative release of a reservoir outlet
Limiter for limiting the change of a variable in a time step to a relative (PERCENTAGE) or absolute (ABSOLUTE) change
Data hierarchy, highest input has highest priority
absolute time controller
relative time controller
Unit delay operator for delaying a value by n times the time step of the model.
table interpolation can be BLOCK or LINEAR, default setting if not provided is LINEAR
table interpolation can be BLOCK or LINEAR, default setting if not provided is LINEAR
reference to time series ID
Interpolation option BLOCK / LINEAR for the two inputs date and value
Lookup table at a date location
reference to time series ID
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
optional period of the year for which the trigger is active
default input value, if input is NaN or infinity
default output, if no combination of the table applies
tolerance for finding a match, keep in mind that the all variable are stored in doubles
number of tables with input, output values, the initial state can be taken into account optionally
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
optionally third input
optional external time series providing the start index in the array with input data, default is 0, i.e. the first element
optional external time series providing the end index in the array with input data, default is nSeries-1, i.e. the last element
timeRelative mode, either "NATIVE" or "RETAINVALUEWHENINACTIVE"
setting if the control table provides the absolute value or the relative value
table interpolation can be BLOCK or LINEAR, default setting if not provided is LINEAR
table with time [s] / value records
optional input for deriving the timeActive in case of the relative from Value option
user-configured constant value
reference to time series ID
reference to time series ID vector
mathematical operator: + (summation), - (substraction), * (multiplication), / (division), min, max
time series ID of resulting value
time series ID vector of resulting value
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
standard trigger
trigger with deadband
trigger with time deadband
mathematical expression
Data hierarchy, highest input has highest priority
trigger with two-dimensional lookup table, trigger results are defined by polygons
set of triggers
spread sheet trigger
Storage table with pairs of elevation h and storage S
Storage equation, storage S = f(water level h)
Maximum water level h in the reservoir: this optional value does not limit the water level, it is used however to compute the relative filling percentage of the reservoir according to s = S/S(maximumLevel), where S is the absolute storage volume
Capacity for free flow, i.e. without a potential impact of the optional tailwater
efficiency table unit power output [MW / m3/s] as function of head [m]
power output [MW]
Table containing data for different elevations. Type of element 'value'
depends on purpose for which table is used.
Table containing data for different elevations. Type of element 'value'
depends on purpose for which table is used.
Constant tailwater level [m]
Tailwater depending on discharge computed by a rating curve
tailwater level [m]
head [m]
Maximum capacity of outlet as function of the water level h, minimum capacity is assumed to be zero
Characteristics of optional turbine
Maximum capacity of outlet as function of the water level h, minimum capacity is assumed to be zero
Power equation for optional segments with lower and upper water level bounds, y = a*(x+b)^c
defined data input as per time series format date time (defined either by dateTime or time or
month day) and value
Upstream inflows [m3/s] into the reservoir, can be more than one for aggregation the inflows from several upstream reservoirs or river reaches
Optional level [m] for updating the simulated level by an observed water level (simple data assimilation), if provided the error output is equal to the mass balance correction
Direct precitation into the reservoir [mm/time step], the value will be multiplied by the current water surface area of the reservoir
Direct evaporation from the reservoir [mm/time step]
aggregated inflows [m3/s]
aggregated release [m3/s]
storage [m3] (state variable)
relative storage [-] typically between 0 and 1 depending on the definition of the maximum level above]
water level [m] in the reservoir
optional error output [m3/s] which is non-zero if the simple data assimilation option for overruling the simulated water level is used
optional residuum of the implicit solution
Reference to timeseries in data configuration containg an absolute release. (ONLY FOR CONTROLLED OUTLET)
Reference to timeseries in data configuration containg the relative release (values inbetween 0 and 1). (ONLY FOR CONTROLLED OUTLET)
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
link the trigger event to either an other trigger or to a rule. Use the item ID as link to rules
Storage characteristics of the node: The storage as a function of water level h. It can be provided as table or as a formula.
Time series with the water level boundary condition, note that a value MUST be provided at all time steps, otherwise the model stops with an error message
Time series with an optional water level for model updating
Time series with an inflow bounday condition, note that a value MUST be provided at all time steps
Cross section in the center of the flow branch.
Roughness (Chezy) as a function of elevation h
Length of the flow branch
slope for optional kinematic wave branch
the wind friction coefficient is given by Cw = alpha1 + alpha2 * Vw, with wind velocity Vw
the wind friction coefficient is given by Cw = alpha1 + alpha2 * Vw, with wind velocity Vw
Tabulated cross section, pairs of elevation h and width b
Pairs of elevation h and roughness C (according to Chezy)
ID of upstream node
ID of downstream node
optional wind velocity at an elevation of 10 m above the water surface (x-direction), implementation is for the inertial model only
optional wind velocity at an elevation of 10 m above the water surface (y-direction), implementation is for the inertial model only
Orifice according to definition in SOBEK-Rural
Weir according to definition in SOBEK-River
Pump
capacity table of hydropower turbine as a function of the water head
capacity equation of hydropower turbine as a function of the water head
constant efficiency over all discharges, typical range is [0.80, 0.90]
provision of absolute turbine release
provision of relative turbine release, 1 = maximum capacity
discharge in m3/s
power production in MW
deprecated
Type of pool routing.
Type of interpolation
Type of limiting
Value option
flow direction
logical operator
relational operator
mathematical operators
options for spatial schetization
reference for capacity
Type of transfer function.
pid mode, either "NATIVE" or "SOBEK2" or "PIDPOS" or PIDVEL"
minimum setting of the actuator
maximum setting of the actuator
maximum speed of the actuation in [unit/s]
factor on the proportional part kp*e
factor on the integral part ki*integral(e)dt
fatcor on differential part kd*de/dt
controllable variable
setting of the actuator
memory of integral part: integral(e)dt
memory of differential part (in fact e of the last time step)