AccumulationSum

Information

|| Transformation: | Sum ||
|| Transformation Group: | Accumulation ||
|| Description: | Calculates the sum of the input for the output period. In case the input is instantaneous or mean and the output is accumulation, then the sum is multiplied by the duration of the input time step in seconds.||

Hydrological Information

|| Purpose and use of Transformation: | This transformation can for instance be used to report the accumulated sum of the discharge per month. ||

|| Background and Exceptions: | In case the input is instantaneous or mean and the output is accumulation, the unit of the input must be unit/s. The input type (scalar or grid) must be the same as the output type and their timestep must be regular. In case the _ignoreMissing_ value is set to _false_, once a missing value is encountered, the output will only contain missing values after that time step. ||

Input

*inputVariable* Regular scalar timeseries or regular grid.

Options

*ignoreMissing* Treat a missing value as 0 (default true).

CoefficientSets

_No connection to CoefficientSets._

Output

*outputVariable* Accumulated sum of the input data.

Configuration Example

_Configuration example for calculation of the mean discharge volume per event for each month._

<?xml version="1.0" encoding="UTF-8"?>
<transformationModule version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/transformationModule.xsd">
&nbsp;&nbsp; &nbsp;<\!-\- input variables \-->
&nbsp;&nbsp; &nbsp;<variable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<variableId>input</variableId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeSeriesSet>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<moduleInstanceId>AccumulationSum</moduleInstanceId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<valueType>scalar</valueType>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<parameterId>H.m</parameterId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<locationId>H-2001</locationId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeSeriesType>external historical</timeSeriesType>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeStep unit="day"/>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<relativeViewPeriod unit="day" start="0" end="30"/>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<readWriteMode>editing visible to all future task runs</readWriteMode>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</timeSeriesSet>
&nbsp;&nbsp; &nbsp;</variable>
&nbsp;&nbsp; &nbsp;<\!-\- output variables \-->
&nbsp;&nbsp; &nbsp;<variable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<variableId>output</variableId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeSeriesSet>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<moduleInstanceId>AccumulationSum</moduleInstanceId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<valueType>scalar</valueType>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<parameterId>Q.m</parameterId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<locationId>H-2001</locationId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeSeriesType>external historical</timeSeriesType>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<timeStep unit="day"/>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<relativeViewPeriod unit="day" start="5" end="25"/>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<readWriteMode>add originals</readWriteMode>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</timeSeriesSet>
&nbsp;&nbsp; &nbsp;</variable>
&nbsp;&nbsp; &nbsp;<\!-\- transformations \-->
&nbsp;&nbsp; &nbsp;<transformation id="accumulation sum">
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<accumulation>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<sum>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<inputVariable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<variableId>input</variableId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</inputVariable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<ignoreMissing>false</ignoreMissing>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<outputVariable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<variableId>output</variableId>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</outputVariable>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</sum>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;</accumulation>
&nbsp;&nbsp; &nbsp;</transformation>
</transformationModule>

Page tree