teaser.logic.archetypebuildings.urbanrenet package

Submodules

teaser.logic.archetypebuildings.urbanrenet.est1a module

class teaser.logic.archetypebuildings.urbanrenet.est1a.EST1a(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None)

Bases: Residential

Archetype for Urban Fabric Type EST1a.

Subclass from Residential for urban fabric type EST1a. Boundary values for this archetype are taken from [15]. The archetype calculation is adapted from [3], with the change of using the facade area to volume ratio of the building. For further information see [16].

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings.

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

iwu_heavy: heavy construction iwu_light: light construction

Attributes:

zone_area_factorsdict

This dictionary contains the name of the zone (str), the zone area factor (float) and the zone usage from BoundaryConditions json (str). (Default see doc string above)

outer_wall_namesdict

This dictionary contains a random name for the outer walls, their orientation and tilt. Default is a building in north-south orientation)

roof_namesdict

This dictionary contains the name of the roofs, their orientation and tilt. Default is one flat roof.

ground_floor_namesdict

This dictionary contains the name of the ground floors, their orientation and tilt. Default is one ground floor.

window_namesdict

This dictionary contains the name of the window, their orientation and tilt. Default is a building in north-south orientation)

inner_wall_namesdict

This dictionary contains the name of the inner walls, their orientation and tilt. Default is one cumulated inner wall.

ceiling_namesdict

This dictionary contains the name of the ceilings, their orientation and tilt. Default is one cumulated ceiling.

floor_namesdict

This dictionary contains the name of the floors, their orientation and tilt. Default is one cumulated floor.

est_factor_win_areafloat

Estimation factor to calculate window area

est_factor_facade_to_volumefloat

Estimation factor to describe the facade area to volume ratio

Notes

The listed attributes are just the ones that are set by the user calculated values are not included in this list. Changing these values is expert mode.

property construction_data

generate_archetype()

Generates a residential building.

With given values, this class generates a type residential building according to TEASER requirements.

property neighbour_buildings

property number_of_apartments

teaser.logic.archetypebuildings.urbanrenet.est1b module

class teaser.logic.archetypebuildings.urbanrenet.est1b.EST1b(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST1b.

Subclass from EST1a for urban fabric type EST1b, with the addition of variable number of apartments as input parameter.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est2 module

class teaser.logic.archetypebuildings.urbanrenet.est2.EST2(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST2.

Subclass from EST1b for urban fabric type EST2. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est3 module

class teaser.logic.archetypebuildings.urbanrenet.est3.EST3(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST3.

Subclass from EST1b for urban fabric type EST3. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est4a module

class teaser.logic.archetypebuildings.urbanrenet.est4a.EST4a(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST4a.

Subclass from EST1b for urban fabric type EST4a. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est4b module

class teaser.logic.archetypebuildings.urbanrenet.est4b.EST4b(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST4b.

Subclass from EST1b for urban fabric type EST4b. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est5 module

class teaser.logic.archetypebuildings.urbanrenet.est5.EST5(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST5.

Subclass from EST1b for urban fabric type EST5. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est6 module

class teaser.logic.archetypebuildings.urbanrenet.est6.EST6(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST6.

Subclass from EST1b for urban fabric type EST6. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est7 module

class teaser.logic.archetypebuildings.urbanrenet.est7.EST7(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST7.

Subclass from EST1b for urban fabric type EST7. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est8a module

class teaser.logic.archetypebuildings.urbanrenet.est8a.EST8a(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST8a.

Subclass from EST1b for urban fabric type EST8a. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)

teaser.logic.archetypebuildings.urbanrenet.est8b module

class teaser.logic.archetypebuildings.urbanrenet.est8b.EST8b(parent, name=None, year_of_construction=None, number_of_floors=None, height_of_floors=None, net_leased_area=None, with_ahu=False, internal_gains_mode=1, neighbour_buildings=None, construction_data=None, number_of_apartments=None)

Bases: EST1a

Urban Fabric Type EST8.

Subclass from EST1b for urban fabric type EST8b. Differs in the facade area to volume ratio.

Parameters:

parent: Project()

The parent class of this object, the Project the Building belongs to. Allows for better control of hierarchical structures. If not None it adds this Building instance to Project.buildings. Default is None

namestr

Individual name

height_of_floorsfloat [m]

Average height of the buildings’ floors

number_of_floorsint

Number of building’s floors above ground

year_of_constructionint

Year of first construction

net_leased_areafloat [m2]

Total net leased area of building. This is area is NOT the footprint of a building

with_ahuBoolean

If set to True, an empty instance of BuildingAHU is instantiated and assigned to attribute central_ahu. This instance holds information for central Air Handling units. Default is False.

internal_gains_mode: int [1, 2, 3]

mode for the internal gains calculation done in AixLib:

1. Temperature and activity degree dependent heat flux calculation for persons. The calculation is based on SIA 2024 (default)

2. Temperature and activity degree independent heat flux calculation for persons, the max. heatflowrate is prescribed by the parameter fixed_heat_flow_rate_persons.

3. Temperature and activity degree dependent calculation with consideration of moisture and co2. The moisture calculation is based on SIA 2024 (2015) and regards persons and non-persons, the co2 calculation is based on Engineering ToolBox (2004) and regards only persons.

neighbour_buildingsint

Number of neighbour buildings. CAUTION: this will not change the orientation of the buildings wall, but just the overall exterior wall and window area(!) (default = 0)

0. no neighbour

1. one neighbour

2. two neighbours

construction_datastr

Construction type of used wall constructions default is “heavy”)

heavy: heavy construction light: light construction

number_of_apartmentsint

number of apartments inside Building (default = 1)