Time sequence (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
(Created page with "In the Water Overlay, a number of elements can be configured as a time sequence rather than a single value. This means that during the simulation, the value used for calcu...")
 
mNo edit summary
Line 4: Line 4:


==Structure of a time sequence==
==Structure of a time sequence==
Time sequences are stored in project data in the form of [[attribute_array]]s. It consists of a sequence of pairs of a time and a value to use for that time. A maximum of 100 values is used, interpreted as 50 individual pairs of a time and a value.
Time sequences are stored in project data in the form of [[attribute array]]s. It consists of a sequence of pairs of a time and a value to use for that time. A maximum of 100 values is used, interpreted as 50 individual pairs of a time and a value.


Depending on the type of element you wish to configure using a time sequence, the interpretation of a time sequence can differ.
Depending on the type of element you wish to configure using a time sequence, the interpretation of a time sequence can differ.
Line 16: Line 16:
===Interpolated===
===Interpolated===
[[Beach (Water Overlay)|Breaches]] use an interpretation by which the used value is interpolated based on the current time in the simulation, the preceding and upcoming defined time in the time sequence, and the associated value.
[[Beach (Water Overlay)|Breaches]] use an interpretation by which the used value is interpolated based on the current time in the simulation, the preceding and upcoming defined time in the time sequence, and the associated value.
==Structure of data==
To import a time sequence
===CSV===
A CSV file may look as follows:
{{code|1=
3600,0.03
7200,0
9000,0.03
108000,0.06
}}
On each row, the first value is the time, and the second value is the value to be used.
===Attribute===
When importing a time sequence in an attribute while [[Import Geo data|importing geo data]], the attribute should contain a list of values which looks as follows:
{{code|1=
[3600, 0.03, 7200, 0, 9000, 0.03, 108000, 0.06]
}}
The first value is the time for the first time-value pair, the second value is the value of that pair. The third value is the time for the second time-value pair, and so forth.
==Notes==
* When importing a CSV for a time sequence, it's possible to indicate whether the time is in seconds, minutes, or hours. The {{software}} then automatically converts the time to the correct data for the model.
* When exporting data which has a time sequence for an attribute, it is formatted in the same structure which can be used to load it back in as an attribute.

Revision as of 13:47, 13 May 2020

In the Water Overlay, a number of elements can be configured as a time sequence rather than a single value. This means that during the simulation, the value used for calculations changes over time.

Time sequences can be loaded in via two methods: directly as attributes of imported Geo data, or by importing a CSV file via the configuration wizard.

Structure of a time sequence

Time sequences are stored in project data in the form of attribute arrays. It consists of a sequence of pairs of a time and a value to use for that time. A maximum of 100 values is used, interpreted as 50 individual pairs of a time and a value.

Depending on the type of element you wish to configure using a time sequence, the interpretation of a time sequence can differ.

Definition by end

Rainfall and evaporation use an interpretation by which the times indicate up to when the value is used.

Definition by start

Hydraulic structures use an interpretation by which the times indicate from when onward a value is used.

Interpolated

Breaches use an interpretation by which the used value is interpolated based on the current time in the simulation, the preceding and upcoming defined time in the time sequence, and the associated value.

Structure of data

To import a time sequence


CSV

A CSV file may look as follows:

3600,0.03
7200,0
9000,0.03
108000,0.06

On each row, the first value is the time, and the second value is the value to be used.

Attribute

When importing a time sequence in an attribute while importing geo data, the attribute should contain a list of values which looks as follows:

[3600, 0.03, 7200, 0, 9000, 0.03, 108000, 0.06]

The first value is the time for the first time-value pair, the second value is the value of that pair. The third value is the time for the second time-value pair, and so forth.

Notes

  • When importing a CSV for a time sequence, it's possible to indicate whether the time is in seconds, minutes, or hours. The Tygron Platform then automatically converts the time to the correct data for the model.
  • When exporting data which has a time sequence for an attribute, it is formatted in the same structure which can be used to load it back in as an attribute.