Net Line

From Tygron Support wiki
Jump to navigation Jump to search

Template:Learned

This article is a stub.

What are net lines

A line, in network simulation terms, is a connection between different nodes in a resource transport and distribution network. Along with the nodes of the network they form a graph.

How net lines relate to the Tygron Engine

In the Tygron Engine, net lines and net nodes, along with net loads, form distribution networks. They are defined by 2 net nodes, a starting node and an end node, and a net line definition. The collection of net lines and net nodes between two arbitrary net nodes is called a path.

Properties of net lines

Net lines have a number of properties, mostly related to visualization. They also allow for the definitions of arbitrary attributes.

Net line definitions

Each net line has a reference to a net line definition. The net line definition's attributes, such as its color or visualization diameter, are inherited by their net lines. This allows a single set of properties to be applied to all lines in the network.

Attributes

Net lines can have any number of arbitrary attributes. A few attribute names are reserved and have a special function.

DEF_DIAMETER_M: The diameter of the net line. This can be used in calculations and also affects the width of the net line as visible in the 3D World.

FLOW: The flow of a net line indicates the amount of the resource that is transported through this net line. If the network's graph is a tree, the direction is implicit and the value can be consistently positive. In more complicated networks, the direction in which the resource is transported may be relevant, and can be indicated with a positive or negative value. By default, the attribute name FLOW is preferred. The specific attribute name used for this is defined as part of the settings of the net type.

VISUALIZATION_DIAMETER_M: The diameter of the net line. Similar to DEF_DIAMETER_M, this attribute affects the visualized width of the net line in the 3D World, but is not intended to be used in calculations.

Adding and editing net lines

It is possible to edit the net lines of the network, but also to import net lines into the project.

Manually editing

Importing GeoJSON

It is possible to import a geojson file to add net lines to a project.

Template:Editor ribbon

It is also possible to select the option of importing data in the Net wizard. In both cases, it is recommended to import all network geojson files at the same time where possible: net lines, net line definitions, and net loads.

The net lines GeoJSON file should be composed of line data with the following attributes.

Attribute Description Example Remark
NAME The name of the net load. NetLoad 49
NET_TYPE The type of network this net load belongs to HEAT Note that when connecting net loads and net nodes or net lines of different network types while importing, this is considered incorrect input and behavior of the Tygron Engine will be undefined.
TYPE_ID The net line definition this net line should be based on HEAT Note that when no net line definition file is being uploaded in the same upload action, this attribute is ignored and the first net line definition of the appropriate net type is used.
START_NODE_ID
END_NODE_ID