Net Load: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
 
(57 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{learned|what net loads are|how net loads relate to the Tygron Engine|how net loads are defined|how to create and edit net loads}}
[[File:Api_current_situation_network.png|thumb|right|400px|[[Net Load]]s in relation to [[Net Node]]s and [[Net Cluster]]s.]]
[[Category:Network]]
In the {{software}}, a net load is a definition of supply or demand which connects to a [[net line|net node]]. turning that node into a load node. A net load does have a geographical location which may be different from the net node is belongs to.
{{stub}}


==What are net loads==
Loads can be imagined as being the (geographical) destinations or origins of resources such as gas or electricity for GAS and ELECTRICITY networks respectively, while the net nodes and [[net lines]] form the extent of the distribution network.
A load, in network simulation terms, is a supply or demand on a resource transport and distribution network. Such a network is composed of nodes connected by lines, in which the nodes with supply or demand are known as load nodes. Based on the supply and demand of various nodes in the network, it is possible to calculate the amount of resource flowing over the various lines.


==How net loads relate to the Tygron Engine==
==Properties==
In the Tygron Engine, a net load is a definition of supply or demand which connects to a [[net line#nodes|net node]] to turn that node into a load node. A net load does have a geographical location in the [[3D World]] which may be different from the net node is belongs to. Loads can be imagined as being the (geographical) destinations or origins of resources such as gas or electricity for GAS and ELECTRICITY networks respectively, while the net nodes and [[net lines]] form the extent of the distribution network.
Net Loads have a number of properties related to their effect on the network. They also allow for the definitions of arbitrary [[attribute]].


==Properties of net loads==
===Name===
Net loads have a number of properties related to their effect on the network. They also allow for the definitions of arbitrary [[attributes]].
The name of the Net Load is generally not visible to the end user, but can be used to keep track of specific Net Loads while editing, or could be called up using TQL to display more information to an end user.
 
===Net Type===
The [[Network#Network_type|network type]] this Net Load belongs to. Each Net Load can only belong to one type of network.


===Root===
===Root===
The root net load indicates a reference net node or origin within the distribution network. Depending on the use-case, the root net load is often a resource supplier, although the net load can have any value for its supply or demand of resources. The Tygron Engine's built-in algorithm for generating networks requires that a root net load is present. This property is also signified by the ROOT_LOAD attribute.
The root Net Load indicates a reference net node or origin within the distribution network. Depending on the use-case, the root Net Load is often a resource supplier, although the Net Load can have any value for its supply or demand of resources. The {{software}}'s built-in algorithm for generating networks requires that a root Net Load is present. This property is also signified by the ROOT_LOAD attribute.


===Time state===
===Time state===
The [[time state]] of the net load indicates whether or not the net load is to be considered active in the network. The following time states are relevant for a net load:
The [[timestate]] of the Net Load indicates whether or not the Net Load is to be considered active in the network. The following time states are relevant for a Net Load:
* NOTHING: The net load is currently not active, and its supply/demand should be ignored.
* NOTHING: The Net Load is currently not active, and its supply/demand should be ignored.
* READY: The net load is currently active, and its supply/demand should be taken into account for calculations.
* READY: The Net Load is currently active, and its supply/demand should be taken into account for calculations.
* REQUEST_CONSTRUCTION_APPROVAL: The load is currently not active, but the owner of the network would like to make it active, requiring permission of the load owner.
* REQUEST_CONSTRUCTION_APPROVAL: The load is currently not active, but the owner of the network would like to make it active, requiring permission of the load owner.
* REQUEST_ZONING_APPROVAL: The net load is currently not active, but the owner of the load would like to make it active, requiring permission of the network owner.
* REQUEST_ZONING_APPROVAL: The Net Load is currently not active, but the owner of the load would like to make it active, requiring permission of the network owner.
 
When requesting the time state of a [[net cluster]], the furthest progressed time state among all Net Loads in the net cluster is returned.


When requesting the time state of a net cluster, the furthest progressed time state among all net loads in the net cluster is returned.
===Owner===
The Net Load can be owned by at most one stakeholder. If the Net Load is linked to a building, the owner of that building becomes the owner of the Net Load. If the Net Load is part of a [[net cluster]], the owner of that cluster becomes the owner of the Net Load. When the Net Load is both linked to a building and part of a cluster, the owner of the cluster takes precedence over the owner of the building.


===Building===
===Building===
When a net load is created or loaded in directly over a building, the load is linked to that building. This allows for [[TQL|queries]] to find the properties of constructions based on the state of the network. Additionally, the owner of the building will also become the owner of the net load, for as long as the net load is linked to that building. Loads are not required to be linked to buildings.
When a Net Load is created or loaded in directly over a building, the load is linked to that building. This allows for [[TQL|queries]] to find the properties of constructions based on the state of the network. Additionally, the owner of the building will also become the owner of the Net Load, for as long as the Net Load is linked to that building, and the Net Load is not part of a cluster owned by a different stakeholder. Net Loads are not required to be linked to buildings.


===Attributes===
===Attributes===
Net loads can have any number of arbitrary attributes. One attribute name is reserved and has a special function.
Net Loads can have any number of arbitrary [[attribute]]s. The following attribute names are reserved and have a special function.
 
'''FLOW''': The flow of a net load indicates the quantity of supply or demand that this net load represents. Positive numbers indicate a demand, and negative numbers indicate a supply. The flow is not a fixed property, but should be added to the net load as an attribute. 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]].
 
'''ROOT_LOAD''': This attribute indicates whether this net load is a root of the network. A "1" indicates that this net load is indeed a root. A "0", or lack of this attribute, means that this net load isn't a root.
 
==Adding and editing Net loads==
It is possible to add and edit net loads manually, but also to import net loads into the project.
 
===Manually editing net loads===
 
===Importing Net loads===
It is possible to import a geojson file to add net loads to a project.


{{Editor ribbon|header=Network|bar=Loads|dropdown=Import GeoJSON File}}
'''FLOW''': The flow of a Net Load indicates the quantity of supply or demand that this Net Load represents. Positive numbers indicate a demand, and negative numbers indicate a supply. The flow is not a fixed property, but should be added to the Net Load as an attribute. 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]]. "FLOW" is the default attribute used to indicate this property, but any attribute may be used. Depending on the [[Net_Setting#Calculation_Model|calculation model]] for networks, this attribute is used in resource flow calculations.


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.
'''ROOT_LOAD''': This attribute indicates whether this Net Load is a root of the network. A "1" indicates that this Net Load is indeed a root. A "0", or lack of this attribute, means that this Net Load isn't a root.


The net loads GeoJSON file should be composed of point data with the following attributes.
{{article end
|howtos=
* [[How to add and remove Net Loads]]
* [[How to edit a Net Load]]
* [[How to import Net Loads using a GeoJSON]]
|seealso=
* [[Net Cluster]]
}}


{| class="wikitable"
{{editor current situation nav}}
! Attribute
[[Category:Items]][[Category:Network]]
! 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.
|-
| STATE
| Whether the net load is connected or not.
| NOTHING
| Any of the timestates mentioned in this article are valid.
|-
| NODE_ID
| The ID of the net node this load belongs to.
| 17
| If this file is being imported along with a net lines file, this NODE_ID should match one of the net lines START_NODE_IDs or END_NODE_IDs.
|-
| CLUSTER_ID
| The ID of the cluster this load should belong to.
| 4
| The cluster of net loads this net load should belong to. A cluster is not created automatically, but after importing these clusters can be created using a cluster generation algorithm.
|-
| ROOT_LOAD
| Whether this net load is a root load or not
| 0
| 1 = root load (producer), 2 = a regular load (consumer)
|-
| ADDRESSCODE
| The postcode this net load is related to.
| 2514EG 46
| When a net load has a postcode which is also found in a building in the 3D world, the net load is automatically linked to that building.
|}

Latest revision as of 15:40, 28 February 2023

Net Loads in relation to Net Nodes and Net Clusters.

In the Tygron Platform, a net load is a definition of supply or demand which connects to a net node. turning that node into a load node. A net load does have a geographical location which may be different from the net node is belongs to.

Loads can be imagined as being the (geographical) destinations or origins of resources such as gas or electricity for GAS and ELECTRICITY networks respectively, while the net nodes and net lines form the extent of the distribution network.

Properties

Net Loads have a number of properties related to their effect on the network. They also allow for the definitions of arbitrary attribute.

Name

The name of the Net Load is generally not visible to the end user, but can be used to keep track of specific Net Loads while editing, or could be called up using TQL to display more information to an end user.

Net Type

The network type this Net Load belongs to. Each Net Load can only belong to one type of network.

Root

The root Net Load indicates a reference net node or origin within the distribution network. Depending on the use-case, the root Net Load is often a resource supplier, although the Net Load can have any value for its supply or demand of resources. The Tygron Platform's built-in algorithm for generating networks requires that a root Net Load is present. This property is also signified by the ROOT_LOAD attribute.

Time state

The timestate of the Net Load indicates whether or not the Net Load is to be considered active in the network. The following time states are relevant for a Net Load:

  • NOTHING: The Net Load is currently not active, and its supply/demand should be ignored.
  • READY: The Net Load is currently active, and its supply/demand should be taken into account for calculations.
  • REQUEST_CONSTRUCTION_APPROVAL: The load is currently not active, but the owner of the network would like to make it active, requiring permission of the load owner.
  • REQUEST_ZONING_APPROVAL: The Net Load is currently not active, but the owner of the load would like to make it active, requiring permission of the network owner.

When requesting the time state of a net cluster, the furthest progressed time state among all Net Loads in the net cluster is returned.

Owner

The Net Load can be owned by at most one stakeholder. If the Net Load is linked to a building, the owner of that building becomes the owner of the Net Load. If the Net Load is part of a net cluster, the owner of that cluster becomes the owner of the Net Load. When the Net Load is both linked to a building and part of a cluster, the owner of the cluster takes precedence over the owner of the building.

Building

When a Net Load is created or loaded in directly over a building, the load is linked to that building. This allows for queries to find the properties of constructions based on the state of the network. Additionally, the owner of the building will also become the owner of the Net Load, for as long as the Net Load is linked to that building, and the Net Load is not part of a cluster owned by a different stakeholder. Net Loads are not required to be linked to buildings.

Attributes

Net Loads can have any number of arbitrary attributes. The following attribute names are reserved and have a special function.

FLOW: The flow of a Net Load indicates the quantity of supply or demand that this Net Load represents. Positive numbers indicate a demand, and negative numbers indicate a supply. The flow is not a fixed property, but should be added to the Net Load as an attribute. 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. "FLOW" is the default attribute used to indicate this property, but any attribute may be used. Depending on the calculation model for networks, this attribute is used in resource flow calculations.

ROOT_LOAD: This attribute indicates whether this Net Load is a root of the network. A "1" indicates that this Net Load is indeed a root. A "0", or lack of this attribute, means that this Net Load isn't a root.

How-to's

See also

Editor ribbon icon current.pngCurrent Situation
Current Situation
Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import
Buildings
Function • Function Override • Traffic Units
Terrain
Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override
Administrative
Neighborhood • Zone • Permission Popup • Plot • Zip Code
Geo Import
Source • GeoShare
Network
Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://support.tygron.com/w/index.php?title=Net_Load&oldid=53814"