...
Output
- output: TODO
Description
Function specified by a custom free format expression and coefficients. Any number of input variables and coefficients can be used in the free format expression. The expression may contain general mathematical operators. A function parser is used to evaluate the expression. For each time step in the output time series the expression is evaluated and the result is written to the output time series.TODO
Configuration examples
Configuration example:
Code Block | ||||
---|---|---|---|---|
| ||||
<transformation id="GenerationTidalConstituentsTest"> <generation> <tidalConstituents> <coefficientSet> <constituent name="M2" amplitude="2.5" phase="1080"/> <constituent name="S1" amplitude="-1.001" phase="-45.001"/> </coefficientSet> <outputVariable> <variableId>output</variableId> </outputVariable> </tidalConstituents> </generation> </transformation> |
...
The location attributes file can contain multiple rows with constituents per location, e.g.:
{code}
location1 M2 2.5 0
location1 S1 -1.001 -45.001
location2 M2 3.5 0
location2 S1 1 10
location2 SA 2 15
{code}
The example below uses coefficientSetFunctions (available since build 30246, i.e. since stable build 2011.01). Here 'X' is a reference to a variable and 'a', 'b' and 'c' are references to coefficients. Here the coefficients are defined in coefficientSetFunctions, where (coef_a), (coef_b) and (coef_c) NAME, AMP and PHASE refer to location number attributes that are defined in the locationSets configuration file. In this case only specify one constituent to link the name, amplitude and phase to the corresponding columns in the locationAttributes file:
Code Block | ||||
---|---|---|---|---|
| ||||
<transformation id="GenerationTidalConstituentsWithLocationAttributesTest"> <generation> <tidalConstituents> <coefficientSetFunctions> <constituent name="@NAME@" amplitude="@AMP@" phase="@PHASE@"/> </coefficientSetFunctions> <outputVariable> <variableId>output</variableId> </outputVariable> </tidalConstituents> </generation> </transformation> |
When using coefficientSetFunctions, the location attributes file can contain multiple rows with constituents per location, e.g.:
ID | NAME | AMP | PHASE |
---|---|---|---|
location1 | M2 | 2.5 | 0 |
location1 | S1 | -1.001 | -45.001 |
location2 | M2 | 3.5 | 0 |
location2 | S1 | 1 | 10 |
location2 | SA | 2 | 15 |