Net Load - Revision history

Frank@tygron.nl at 14:40, 20 April 2026

2026-04-20T14:40:52Z

← Older revision		Revision as of 14:40, 20 April 2026
Line 45:		Line 45:
	\|seealso=		\|seealso=
	* [[Net Cluster]]		* [[Net Cluster]]

			\|api=*[[Api session items netloads]]
	}}		}}

	{{editor current situation nav}}		{{editor current situation nav}}
	[[Category:Items]][[Category:Network]]		[[Category:Items]][[Category:Network]]

Frank@tygron.nl: /* Properties of net loads */

2023-02-28T15:40:03Z

Properties of net loads

← Older revision		Revision as of 15:40, 28 February 2023
Line 4:		Line 4:
	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.		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 ~~of net loads~~==		==Properties==
	Net ~~loads~~ have a number of properties related to their effect on the network. They also allow for the definitions of arbitrary [[attribute]].		Net Loads have a number of properties related to their effect on the network. They also allow for the definitions of arbitrary [[attribute]].

	===Name===		===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.		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===		===Net Type===
	The [[Network#Network_type\|network type]] this ~~net load~~ belongs to. Each ~~net load~~ can only belong to one type of network.		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 {{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.		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 [[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~~:		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===		===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.		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, 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.		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 [[attribute]]s. The following attribute names are reserved and have 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]]. "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.		'''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.

	'''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.		'''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.

	{{article end		{{article end

Frank@tygron.nl: /* Adding and editing net loads */

2023-02-28T15:38:09Z

Adding and editing net loads

← Older revision		Revision as of 15:38, 28 February 2023
Line 38:		Line 38:
	'''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.		'''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==~~		{{article end
	~~It is possible to add and edit net loads manually, but also to import net loads into the project.~~		\|howtos=

	=~~==Manually editing===~~
	~~It is possible to define each net load manually, using the built-in editing options.~~

	* [[How to add and remove Net Loads]]		* [[How to add and remove Net Loads]]
	* [[How to edit a Net Load]]		* [[How to edit a Net Load]]

	* [[How to import Net Loads using a GeoJSON]]		* [[How to import Net Loads using a GeoJSON]]
			\|seealso=
			* [[Net Cluster]]
			}}

	{{editor current situation nav}}		{{editor current situation nav}}
	[[Category:Items]][[Category:Network]]		[[Category:Items]][[Category:Network]]

Frank@tygron.nl at 15:36, 28 February 2023

2023-02-28T15:36:24Z

← Older revision		Revision as of 15:36, 28 February 2023
Line 1:		Line 1:
	[[File:Api_current_situation_network.png\|thumb\|right\|400px\|[[Net ~~Line~~]]s in relation to [[Net Node]]s and [[Net ~~Load~~]]s.]]		[[File:Api_current_situation_network.png\|thumb\|right\|400px\|[[Net Load]]s in relation to [[Net Node]]s and [[Net Cluster]]s.]]
	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.		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.

Frank@tygron.nl: Frank@tygron.nl moved page Net load to Net Load over redirect

2023-02-28T15:31:31Z

Frank@tygron.nl moved page Net load to Net Load over redirect

← Older revision	Revision as of 15:31, 28 February 2023
(No difference)

Frank@tygron.nl: /* Importing GeoJSON */

2023-02-28T15:30:42Z

Importing GeoJSON

@@ Line 47: / Line 47: @@
 * [[How to edit a Net Load]]
-===Importing GeoJSON===
+* [[How to import Net Loads using a GeoJSON]]
 {{editor current situation nav}}
 [[Category:Items]][[Category:Network]]

Frank@tygron.nl: /* Manually editing */

2023-02-28T15:29:46Z

Manually editing

← Older revision		Revision as of 15:29, 28 February 2023
Line 45:		Line 45:

	* [[How to add and remove Net Loads]]		* [[How to add and remove Net Loads]]
	* [[How to edit Net ~~Loads~~]]		* [[How to edit a Net Load]]

	===Importing GeoJSON===		===Importing GeoJSON===

Frank@tygron.nl: /* Manually editing */

2023-02-28T15:29:37Z

Manually editing

← Older revision		Revision as of 15:29, 28 February 2023
Line 45:		Line 45:

	* [[How to add and remove Net Loads]]		* [[How to add and remove Net Loads]]
			* [[How to edit Net Loads]]

	===Importing GeoJSON===		===Importing GeoJSON===

Frank@tygron.nl: /* Changing net loads */

2023-02-28T15:29:20Z

Changing net loads

← Older revision		Revision as of 15:29, 28 February 2023
Line 45:		Line 45:

	* [[How to add and remove Net Loads]]		* [[How to add and remove Net Loads]]

	~~====Changing net loads====~~
	~~{{Editor location\|Net loads\|Net load}}~~

	~~[[File:net-loads-properties.jpg\|framed\|left\|The right panel for net loads in the editor.]]~~

	~~=====Name=====~~
	~~[[File:net-load-right-name.jpg\|frame\|right\|The field for the "name".]]~~
	~~: ''The name of the net load. This is generally not visible to the end-user. You can change this by altering the text in the "Name" field.''<br clear=right>~~

	~~=====Net Type=====~~
	~~[[File:net-load-right-nettype.jpg\|frame\|right\|The dropdown menu for the "network type".]]~~
	~~: ''The network type this load belongs to. You can change this by selecting a different network type from the dropdown menu.''<br clear=right>~~

	~~=====Is Root=====~~
	~~[[File:net-load-right-root.jpg\|frame\|right\|The checkbox for whether this is a root load.]]~~
	~~: ''If this checkbox for "Is Root" is checked, this load is a root load. This means that this load is a producer in the network.''<br clear=right>~~

	~~=====Time state=====~~
	~~[[File:net-load-right-state.jpg\|frame\|right\|The dropdown menu for the "time state".]]~~
	~~: ''Whether or not the net load is connected, or in what step of the process this load resides. You can change this by selecting a different time state from the dropdown menu.''<br clear=right>~~

	~~=====Building=====~~
	~~[[File:net-load-right-building.jpg\|frame\|right\|The "Select Building" button, and the checkbox to disconnect from a building.]]~~
	: ''A load can be associated with a building. To do this, select "Select Building", and select a [[Building]] in the [[3D Visualization]]. To remove the association with a building, uncheck the "Has Building" checkbox.''<br clear=right>

	~~=====Node=====~~
	~~[[File:net-load-right-node.jpg\|frame\|right\|The "Select Node" button, and the checkbox to disconnect from a node.]]~~
	: ''A load can be associated with a node. To do this, select "Select Building", and select a node in the 3D Visualization. To remove the association with a node, uncheck the "Has Node" checkbox.''<br clear=right>

	~~=====Position=====~~
	~~[[File:net-load-right-position.jpg\|frame\|right\|The "Set Position" button, and the checkbox to remove the override of its default position.]]~~
	: ''A load can have an explicitly determined position. To set its position, select "Set Position", and use the [[brush]] to select a location. To restore its position to the default location (or remove it from the [[project]] when the load does not have a default location, uncheck the "Set Position" checkbox.''<br clear=right>


	~~<br style="clear:both;">~~

	===Importing GeoJSON===		===Importing GeoJSON===

Frank@tygron.nl: /* Manually editing */

2023-02-28T15:28:42Z

Manually editing

← Older revision		Revision as of 15:28, 28 February 2023
Line 44:		Line 44:
	It is possible to define each net load manually, using the built-in editing options.		It is possible to define each net load manually, using the built-in editing options.

	~~====Adding/removing net loads====~~		* [[How to add and remove Net Loads]]
	~~{{Editor location\|net loads}}~~

	[[~~File:net-loads-list.jpg\|framed\|left\|The left panel for net loads in the editor.~~]]

	In the overview of net loads, all net loads are automatically displayed grouped into their [[net cluster]]s, or into the groups "Roots" (for root loads) or "unclustered" (for loads which are not part of a cluster). Within these clusters, the net loads are then grouped by network type (i.e. HEAT, GAS, etc).

	~~{{Editor steps\|title=add a net load\|Select the desired Net Type.\|Select "Add Load".}}~~
	{{Editor steps\|title=remove a net load\|Select the cluster the net load is in (or Roots or Unclustered if the load is a root or unclustered.\|Select the specific net load you wish to remove.\|Select "Remove".}}
	~~<br style="clear:both;">~~

	====Changing net loads====		====Changing net loads====