fairyfly_therm.properties.shape module¶

Shape Therm Properties.

class fairyfly_therm.properties.shape.ShapeThermProperties(host, material=None)[source]¶

Bases: object

Therm Properties for Fairyfly Shape.

Parameters:

host – A fairyfly_core Shape object that hosts these properties.
material – An optional Material object to set the conductive properties of the Shape. The default is set to a generic concrete material.

Properties:

apply_properties_from_dict(abridged_data, materials)[source]¶

Apply properties from a ShapeThermPropertiesAbridged dictionary.

Parameters:

abridged_data – A ShapeThermPropertiesAbridged dictionary (typically coming from a Model).
materials – A dictionary of materials with material identifiers as keys, which will be used to re-assign materials.

duplicate(new_host=None)[source]¶

Get a copy of this object.

Parameters:: new_host – A new Shape object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]¶

Create ShapeThermProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters:

data – A dictionary representation of ShapeThermProperties with the format below.
host – A Shape object that hosts these properties.

{
"type": 'ShapeThermProperties',
"material": {},  # A SolidMaterial or CavityMaterial dictionary
}

is_equivalent(other)[source]¶

Check to see if these therm properties are equivalent to another object.

This will only be True if all properties match (except for the host) and will otherwise be False.

to_dict(abridged=False)[source]¶

Return therm properties as a dictionary.

Parameters:: abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.