Function Value

From Tygron Support wiki
Jump to navigation Jump to search

Function values are specific values which form the general properties of any building with a specific function. A function has many function values, and any building of that function also has those function values.

Function values can be changed for an individual building, or for a function, which in turn would affect all buildings of that function.

Overwrites

Function Values can be defined on several levels. Primarily, they can be defined on Functions. The Function Values of Functions can be overwritten by adding them to the Function Values window. Additionally, a Function can be duplicated, and that new Function will effectively have the same values of the original Function. Lastly, regardless of the Function a Building has, it can have its own Function Values as well. This means the used Function Values are determined as follows:

  • If a building has their own Function Value set, that value is used.
  • Otherwise, if the building's Function has an explicit Function Value defined, that value is used.
  • Otherwise, if that Function was created by duplicating another Function, that Function's value is used. This step is repeated until either a value is found, or the original Function (from which all the others are derived) is found.
  • The original Function always has a valid Function Value.

Category values

Some function values are building-related, and some function values are category-related. The difference between them is only applicable if a single function consists of multiple function categories. For example, the function value indicating the maximum amount of floors for the building is related to the building as a whole. However, if the function contains both social housing and luxury housing, the individual types of housing can have different unit sizes configured, as one type of housing may offer bigger housing units than the other.

When accessing a category value as an attribute, the attribute's name is prefixed by the category's name. For example: UNIT_SIZE_M2 becomes SOCIAL_UNIT_SIZE_M2.

Overview of all function values

Most function values have specific effects in the context of the Tygron Platform. Individual function values can be grouped into categories based on their effects or themes.

Name

Function value Attribute Unit Per category Range Description
Name (Property of function value) text The name of the Function.

Assets and visualisation

Function value Attribute Unit Per category Range Description
Image (Property of function value) Image (png, 200x100) The image used to represent this function. This property is no longer used.
Extra color EXTRA_COLOR color No -2147483648 to 2147483647 The color of the walls of the floors of the building which are neither the top nor bottom floor.
Ground color GROUND_COLOR color No -2147483648 to 2147483647 The color of the walls of the bottom floor of a building.
Roof color ROOF_COLOR color No -2147483648 to 2147483647 The color of the roof of a building. For flat building (such as gardens and roads), it is also the color of the ground surface.
Terrain mix TERRAIN_MIX fraction No 0 to 1 The transparency of the ground color of the function.
Top color TOP_COLOR color No -2147483648 to 2147483647 The color of the walls of the top floor of a building, unless that floor is also the bottom floor.
Description (Property of function value) text The textual description of this function, which is displayed to the user when using this function as as action.

Construction

Floating (Function Value)

Function value Attribute Unit Per category Range Description
Align Elevation ALIGN_ELEVATION Integer No 0 to 2 Attribute that determines whether a Building is aligned relative to the elevation model (in case of an uneven surface), flat on the ground, or floating.
Category weight CATEGORY_WEIGHT decimal Yes 4.9E-324 to 1.7976931348623157E308 How much of a building of this function is classified under the specified category.
Default floors DEFAULT_FLOORS integer No 1 to 250 How many floors a building of this function will have by default, unless otherwise specified. When using this Function as an Action, this is the default amount of floors created, unless the user changes this setting while performing the Action. This values must always be in the range of min floors and max floors (inclusive).
Floor height m FLOOR_HEIGHT_M m No 0 to 1.7976931348623157E308 The height of each floor of the Building.
Height offset HEIGHT_OFFSET_M m No -1.7976931348623157E308 to 1.7976931348623157E308 How many meters above or below the datum this building should be visualized. This is intended for bridges or other buildings on water, so that they can be lined up appropriately with the surrounding land, or float at an appropriate height.
Max floors MAX_FLOORS integer No 1 to 250 The maximum amount of floors this Building (or any of its sections) can have. This also limits how many floors a Building can have when used as an action during a session.
Min floors MIN_FLOORS integer No 1 to 250 The minimum amount of floors this Building (or any of its sections) should have. This also limits how many floors a Building must have when used as an action during a session.
Monumental MONUMENTAL boolean No 0 to 1 Whether this building is monumental. Monumental buildings can be disallowed for demolition by the zoning plan.
Slanting roof height SLANTING_ROOF_HEIGHT m No 0 to 10 How high the slanting roof at the top of the building should be visualized at its peak. The roof will slant inwards equally from all sides. This is a visual effect only, but it is possible to reference this value in custom calculations.
Solar Panels SOLAR_PANELS Boolean No 0 to 1 Attribute that determines whether a Building has solar panels or not.
Solid SOLID boolean No 0 to 1 Whether a building is part of the DSM.
Unit size UNIT_SIZE_M2 m²/unit Yes 0 to 1.7976931348623157E308 How large a single housing unit within this Building is. This is only relevant for residential categories.
Zoning permit required ZONING_PERMIT_REQUIRED boolean No 0 to 1 Whether the municipal stakeholder should be requested permission, when another user uses this function as an action to plan a new building during a session.

Environment

Function value Attribute Unit Per category Range Description
Bowen ratio BOWEN_RATIO ratio No 0.001 to 10 The ratio between two forms of heat transfer between this building's surface and the atmosphere.
Critical infrastructure CRITICAL_INFRASTRUCTURE integer No 0 to 10 Number indicating the critical infrastructure priority of a building in case of calamities.
Distance zone m DISTANCE_ZONE_M m No 0 to 2000.0 The distance drawn in Distance Overlays by this building.
Disturbance distance m DISTURBANCE_DISTANCE_M m No 0 to 2000.0 The distance drawn in the Distance Overlay by this building.
Foliage crown factor FOLIAGE_CROWN_FACTOR ratio No 0 to 10 The ratio between the height of tree trunks and the radius of the foliage of the tree.
Heat effect HEAT_EFFECT °C No -10 to 10 The capacity of this building for heat retention.
Livability effect LIVABILITY_EFFECT decimal No -10 to 10 The effect this building has on the Livability Overlay calculations.
Safety distance m SAFETY_DISTANCE_M m No 0 to 2000.0 The distance drawn in a Distance Overlay by this building.
Vegetation fraction VEGETATION_FRACTION fraction No 0 to 1 The amount of green which this building provides per m². Generally, this number is used along with the building's footprint, rather than its total floor size.

Financial

Function value Attribute Unit Per category Range Description
Buyout cost BUYOUT_COST_M2 currency/m² Yes 0 to 1.7976931348623157E308 How much it costs, in addition to the demolition costs, to demolish this Building during a session, when the Building is not vacant. These costs are due to eviction or buyout of existing tenants.
Construction cost CONSTRUCTION_COST_M2 currency/m² Yes 0 to 1.7976931348623157E308 How much it costs to create a new building, when using this function as an action during a session.
Demolition cost DEMOLISH_COST_M2 currency/m² Yes 0 to 1.7976931348623157E308 How much it costs to demolish this Building during a session. If the building is not vacant, the buyout costs are applicable as well, in addition to the demolition costs.
Sell price SELL_PRICE_M2 currency/m² Yes 0 to 1.7976931348623157E308 How much revenue is generated for the owner, when a building of this function is created during a session. The income is only generated once, when the construction of the building has completed.

Network

Function value Attribute Unit Per category Range Description
Heat flow change per year HEAT_FLOW_M2_CHANGE_PER_YEAR m²/year Yes -1.7976931348623157E308 to 1.7976931348623157E308 For any net load connected to an address part of a Building of this function, the amount of resources (FLOW) requested in addition to those in the starting year during every subsequent year. The amount of resources requested starts at HEAT_FLOW_M2_START_VALUE in the start year, and is then increased by this value every year until the building's year of creation, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
Heat flow formula start year HEAT_FLOW_M2_START_YEAR year Yes 0 to 3000 For any net load connected to an Address part of a Building of this function, the start year for the calculation of the amount of resources (FLOW) requested. The amount of resources requests starts at HEAT_FLOW_M2_START_VALUE in this year, and is then increased by HEAT_FLOW_M2_CHANGE_PER_YEAR every year until the building's year of creation, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
Heat flow to power multiplier HEAT_POWER_TO_FLOW_MULTIPLIER factor Yes -1.7976931348623157E308 to 1.7976931348623157E308 For any net load connected to an address part of a building of this function, the divisor used to convert the automatically calculated FLOW to an automatically calculated POWER attribute. The automatically calculated FLOW divided by this value is the automatically calculated POWER. Note that an explicitly defined FLOW attribute is not used in this calculation.
Heat flow value at start year HEAT_FLOW_M2_START_VALUE m² Yes -100 to 100 For any net load connected to an address part of a Building of this function, the amount of resources (FLOW) requested by the net load in the defined starting year. This value is increased with the HEAT_FLOW_M2_CHANGE_PER_YEAR, until the building's year of Building, and finally multiplied by the size of the address(es) the net load is associated with to get a default FLOW value for the net load.
Pipes permitted PIPES_PERMITTED boolean No 0 to 1 Whether net lines are allowed to be generated under this building.

Traffic

Traffic is split up into two further categories, to differentiate between traffic which may apply to Traffic Overlays and alternative types of traffic.

Car traffic

Function value Attribute Unit Per category Range Description
Buses per hour NUM_BUSES vehicles/h No 0 to 1.7976931348623157E308 How many buses move over any given cross-section of the road per hour, spread across all lanes.
Cars per hour NUM_CARS vehicles/h No 0 to 1.7976931348623157E308 How many cars move over any given cross-section of the road per hour, spread across all lanes.
Trucks per hour NUM_TRUCKS vehicles/h No 0 to 1.7976931348623157E308 How many trucks move over any given cross-section of the road per hour, spread across all lanes.
Vans per hour NUM_VANS vehicles/h No 0 to 1.7976931348623157E308 How many vans move over any given cross-section of the road per hour, spread across all lanes.
Bus jam factor JAM_FACTOR_BUSES fraction No 0 to 1 The fraction of buses considered to be in traffic jam.
Car jam factor JAM_FACTOR_CARS fraction No 0 to 1 The fraction of cars considered to be in traffic jam.
Truck jam factor JAM_FACTOR_TRUCKS fraction No 0 to 1 The fraction of trucks considered to be in traffic jam.
Van jam factor JAM_FACTOR_VANS fraction No 0 to 1 The fraction of vans considered to be in traffic jam.
Lanes TRAFFIC_LANES integer No -1.7976931348623157E308 to 1.7976931348623157E308 How many lanes of traffic there are on this road. A negative value causes vehicles to move in the opposite direction. This is only relevant for roads, intersections, and bridges. This only affects the visualization.
Noise sigma TRAFFIC_NOISE_SIGMA dB(A) No -1.7976931348623157E308 to 1.7976931348623157E308 Difference in noise intensity of vehicles at their reference speed. Effectively a flat modifier in noise.
Noise tau TRAFFIC_NOISE_TAU dB(A) No -1.7976931348623157E308 to 1.7976931348623157E308 Difference in noise intensity of vehicles for every order of magnitude difference with their reference speed. Effectively a speed-dependent modifier in noise.
Parking lots PARKING_LOTS_PER_M2 parking lot/m² Yes 0 to 1 How many parking lots are available per m² of this building.
Parking lots demand PARKING_LOTS_DEMAND_PER_M2 parking lot/m² Yes 0 to 2 How many parking lots are required per m² of this building.
Speedlimit TRAFFIC_SPEED km/h No 0 to 1.7976931348623157E308 How fast vehicles move on this building. This is only relevant for roads, intersections, and bridges. This affects the visualization, and the calculations for the Traffic Noise Overlay.

Other traffic

Function value Attribute Unit Per category Range Description
Airplanes per hour NUM_AIRPLANES vehicles/h No 0 to 1.7976931348623157E308 How many airplanes move over the given air traffic route, per hour.
Bicycles per hour NUM_BICYCLES vehicles/h No 0 to 1.7976931348623157E308 How many bicycles move over the given bicycle traffic route, per hour.
Pedestrians per hour NUM_PEDESTRIANS pedestrians/h No 0 to 1.7976931348623157E308 How many pedestrians move over the given route, per hour.
Ships per hour NUM_SHIPS vehicles/h No 0 to 1.7976931348623157E308 How many ships move over the given ship traffic route, per hour.
Trains per hour NUM_TRAINS vehicles/h No 0 to 1.7976931348623157E308 How many trains move over the given tracks, per hour.
Trams per hour NUM_TRAMS vehicles/h No 0 to 1.7976931348623157E308 How many trams move over the tracks, per hour.

Water

Function value Attribute Unit Per category Range Description
Connected to sewer area SEWERED boolean No 0 to 1 Whether this building can be connected to a sewer.
Depth of plant roots ROOT_DEPTH_M m No 0 to 1.7976931348623157E308 The depth of the roots of the plants of this building.
Drainage DRAINAGE m No -10 to 10 Whether this Building has drainage, which affects the calculation of the Subsidence Overlay.
Ground infiltration per day GROUND_INFILTRATION_MD m/day No 0 to 1.7976931348623157E308 The permeability of this building to water trying to infiltrate into the ground.
Manning value WATER_MANNING s/(m1/3) No 0.01 to 0.255 The manning value of the building, which is a roughness in regards to water flow.
Water evaporation WATER_EVAPORATION_FACTOR factor No 0 to 1.7976931348623157E308 Factor indicating how much a building with a crop, tree or plant function facilitates evapotranspiration. This factor is multiplied with the weather's evaporation rate at a particular time in the simulation.
Water microrelief WATER_MICRORELIEF_M m No 0 to 0.255 The height and depth of microrelief hills, in which water can be stored.
Water storage WATER_STORAGE_M2 m³/m² No 0 to 1.7976931348623157E308 How much water can be stored in this building.

Attributes

Besides the function values which are provided by default, it is possible to add user-defined attributes to function values as well. Any attribute added is automatically available as an Attribute for all Functions, and all Buildings, although the default value of the Attribute will be 0.

User-defined Attributes added to a function value always apply to the building as a whole, and cannot be category-specific.

Function value Attribute Unit Per category Range Description
  PRIVATE_YARD boolean Whether the building is a private yard belonging to a residence or private stakeholder.
(user defined) (user defined) (user defined) Attributes can be used to assign any additional values or properties to functions and the buildings which derive from them.

How-to's

Videos

FAQ Webinar, which touches on Function Values.
Retrieved from "https://support.tygron.com/w/index.php?title=Function_Value&oldid=56853"