archetypal.template.DomesticHotWaterSetting

class archetypal.template.DomesticHotWaterSetting(Name, WaterSchedule=None, IsOn=True, FlowRatePerFloorArea=0.03, WaterSupplyTemperature=65, WaterTemperatureInlet=10, area=1, **kwargs)[source]

Domestic Hot Water settings.

Initialize object with parameters.

Parameters

area (float) – The area the zone associated to this object.
IsOn (bool) – If True, dhw is on.
WaterSchedule (UmiSchedule) – Schedule that modulates the FlowRatePerFloorArea.
FlowRatePerFloorArea (float) – The flow rate per flow area [m³/(hr·m²)].
WaterSupplyTemperature (float) – The water supply temperature [degC].
WaterTemperatureInlet (float) – The water temperature intel from the water mains [degC].
**kwargs – keywords passed to parent constructors.

property FlowRatePerFloorArea: Get or set the flow rate per flow area [m³/(hr·m²)].

property IsOn: Get or set the availability of the domestic hot water [bool].

property WaterSchedule: Get or set the schedule which modulates the FlowRatePerFloorArea.

property WaterSupplyTemperature: Get or set the water supply temperature [degC].

property WaterTemperatureInlet: Get or set the water temperature intel from the water mains [degC].

property area: Get or set the area of the zone associated to this object [m²].

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

Create a DomesticHotWaterSetting from a dictionary.

Parameters

data (dict) – The python dictionary.
schedules (dict) – A dictionary of UmiSchedules with their id as keys.
**kwargs – keywords passed the MaterialBase constructor.

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

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

combine(other, **kwargs)[source]

Combine two DomesticHotWaterSetting objects together.

Notes

When combining 2 DomesticHotWater Settings objects, the WaterSchedule must be averaged via the final quantity which is the peak floor rate [m3/hr/m2] * area [m2].

(
    np.average(
        [zone_1.WaterSchedule.all_values, zone_2.WaterSchedule.all_values],
        axis=0,
        weights=[
            zone_1.FlowRatePerFloorArea * zone_1.area,
            zone_2.FlowRatePerFloorArea * zone_2.area,
        ],
    )
    * (combined.FlowRatePerFloorArea * 100)
).sum()

Parameters

other (DomesticHotWaterSetting) – The other object.
**kwargs – keywords passed to the constructor.

Returns

a new combined object.

Return type

(DomesticHotWaterSetting)

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.

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.

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

classmethod whole_building(idf)[source]

Create one DomesticHotWaterSetting for whole building model.

Parameters: idf (IDF) – The idf model.
Returns: The DomesticHotWaterSetting object.
Return type: DomesticHotWaterSetting

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.