archetypal.template.ZoneConstructionSet

class archetypal.template.ZoneConstructionSet(Name, Facade=None, Ground=None, Partition=None, Roof=None, Slab=None, IsFacadeAdiabatic=False, IsGroundAdiabatic=False, IsPartitionAdiabatic=False, IsRoofAdiabatic=False, IsSlabAdiabatic=False, area=1, volume=1, **kwargs)[source]

ZoneConstructionSet class.

Create a ZoneConstructionSet object.

Parameters

Name (str) – Name of the object. Must be Unique.
Facade (OpaqueConstruction) – The OpaqueConstruction object representing a facade.
Ground (OpaqueConstruction) – The OpaqueConstruction object representing a ground floor.
Partition (OpaqueConstruction) – The OpaqueConstruction object representing a partition wall.
Roof (OpaqueConstruction) – The OpaqueConstruction object representing a roof.
Slab (OpaqueConstruction) – The OpaqueConstruction object representing a slab.
IsFacadeAdiabatic (bool) – If True, surface is adiabatic.
IsGroundAdiabatic (bool) – If True, surface is adiabatic.
IsPartitionAdiabatic (bool) – If True, surface is adiabatic.
IsRoofAdiabatic (bool) – If True, surface is adiabatic.
IsSlabAdiabatic (bool) – If True, surface is adiabatic.
**kwargs –

property Facade: Get or set the Facade OpaqueConstruction.

property Ground: Get or set the Ground OpaqueConstruction.

property Partition: Get or set the Partition OpaqueConstruction.

property Roof: Get or set the Roof OpaqueConstruction.

property Slab: Get or set the Slab OpaqueConstruction.

property IsFacadeAdiabatic: Get or set is facade adiabatic [bool].

property IsGroundAdiabatic: Get or set is ground adiabatic [bool].

property IsPartitionAdiabatic: Get or set is partition adiabatic [bool].

property IsRoofAdiabatic: Get or set is roof adiabatic [bool].

property IsSlabAdiabatic: Get or set is slab adiabatic [bool].

property area: Get or set the area of the zone [m²].

property volume: Get or set the volume of the zone [m³].

property Category: Get or set the Category attribute.

property Comments: Get or set the object comments.

property DataSource: Get or set the datasource of the object.

property Name: Get or set the name of the object.

property allow_duplicates: Get or set the use of duplicates [bool].

extend(other, allow_duplicates)

Append other to self. Modify and return self.

Parameters: other (UmiBase) –
Returns: self
Return type: UmiBase

float_mean(other, attr, weights=None)

Calculates the average attribute value of two floats. Can provide weights.

Parameters

other (UmiBase) – The other UmiBase object to calculate average value with.
attr (str) – The attribute of the UmiBase object.
weights (iterable, optional) – Weights of [self, other] to calculate weighted average.

classmethod from_dict(data, opaque_constructions, **kwargs)[source]

Create a ZoneConstructionSet from a dictionary.

Parameters

data (dict) – The python dictionary.
opaque_constructions (dict) – A dictionary of OpaqueConstruction with their id as keys.
**kwargs – keywords passed parent constructor.

{
  "$id": "168",
  "Facade": {
    "$ref": "35"
  },
  "Ground": {
    "$ref": "42"
  },
  "Partition": {
    "$ref": "48"
  },
  "Roof": {
    "$ref": "39"
  },
  "Slab": {
    "$ref": "45"
  },
  "IsFacadeAdiabatic": false,
  "IsGroundAdiabatic": false,
  "IsPartitionAdiabatic": false,
  "IsRoofAdiabatic": false,
  "IsSlabAdiabatic": false,
  "Category": "Office Spaces",
  "Comments": null,
  "DataSource": "MIT_SDL",
  "Name": "B_Off_0 constructions"
}

get_unique(): Return first object matching equality in the list of instantiated objects.

property id: Get or set the id.

property predecessors

Get or set the predecessors of self.

Of which objects is self made of. If from nothing else then self, return self.

rename(name)

renames self as well as the cached object

Parameters: name (str) – the name.

to_ref(): Return a ref pointer to self.

combine(other, weights=None, **kwargs)[source]

Combine two ZoneConstructionSet objects together.

Parameters

other (ZoneConstructionSet) –
kwargs – keywords passed to constructor.

Returns

the combined ZoneConstructionSet object.

Return type

(ZoneConstructionSet)

to_dict()[source]: Return ZoneConstructionSet dictionary representation.

validate()[source]: Validate object and fill in missing values.

mapping(validate=True)[source]

Get a dict based on the object properties, useful for dict repr.

Parameters: validate (bool) – If True, try to validate object before returning the mapping.

duplicate()[source]: Get copy of self.