fairyfly_therm.result module

Module for parsing THERM results.

class fairyfly_therm.result.THMZResult(file_path)[source]

Bases: object

Object for parsing results out of simulated THMZ files.

Parameters:

file_path – Full path to a THMZ file that was simulated using THERM.

Properties:

  • file_path

  • u_factors

  • plane

  • shape_polygons

  • shape_faces

  • mesh

  • temperatures

  • heat_fluxes

  • heat_flux_magnitudes

ToString()[source]

Overwrite .NET ToString.

property file_path

Get the path to the .thmz file.

property heat_flux_magnitudes

Get a tuple of heat flux values in W/m2 in that correspond to mesh vertices.

Will be None if the THMZ file has not been simulated and there are no steady state results in the file.

property heat_fluxes

Get a tuple of Vector2Ds that correspond to the mesh vertices for heat fluxes.

Will be None if the THMZ file has not been simulated and there are no steady state results in the file.

property mesh

Get a ladybug-geometry Mesh3D for the finite element mesh of the model.

Will be None if the THMZ file has not been simulated and there is no Mesh in the file.

property plane

Get a ladybug-geometry Plane for the 3D plane in which the mesh exists.

This will be the World XY plane if there is no plane information in the THMZ file.

property shape_faces

Get a ladybug-geometry Face3Ds for the Shape geometries in the THMZ file.

property shape_polygons

Get a ladybug-geometry Polygon2Ds for the Shape geometries in the THMZ file.

property temperatures

Get a tuple of temperatures in Celsius that correspond to the mesh vertices.

Will be None if the THMZ file has not been simulated and there are no steady state results in the file.

property u_factors

Get a tuple of UFactor objects for the .

This will be None if there is no U-Factor information in the THMZ file and this will be an empty tuple if the model had no U-Factor tags assigned to it.

class fairyfly_therm.result.UFactor(xml_element)[source]

Bases: object

Object for holding the results of an individual U-factor tag.

Parameters:

xml_element – An XML element for a U-factor result in the SteadyStateResults.xml file.

Properties:

  • name

  • delta_temperature

  • heat_flux

  • total_u_factor

  • total_length

  • projected_x_u_factor

  • projected_x_length

  • projected_y_u_factor

  • projected_y_length

  • projected_in_glass_plane_u_factor

  • projected_in_glass_plane_length

  • custom_rotation_u_factor

  • custom_rotation_length

ToString()[source]

Overwrite .NET ToString.

property custom_rotation_length

Get a number for the custom rotation-projected length in mm.

property custom_rotation_u_factor

Get a number for the custom rotation-projected U-Factor in W/m2-K.

property delta_temperature

Get a number for the temperature delta across the boundaries in Celsius.

property heat_flux

Get a number for the heat flux across the boundaries in W/m2.

property name

Get the name of the U-factor tag.

property projected_in_glass_plane_length

Get a number for the glass plane-projected length in mm.

property projected_in_glass_plane_u_factor

Get a number for the glass plane-projected U-Factor in W/m2-K.

property projected_x_length

Get a number for the X-projected length the boundaries in mm.

property projected_x_u_factor

Get a number for the X-projected U-Factor across the boundaries in W/m2-K.

property projected_y_length

Get a number for the Y-projected length the boundaries in mm.

property projected_y_u_factor

Get a number for the X-projected U-Factor across the boundaries in W/m2-K.

property total_length

Get a number for the total length the boundaries in mm.

property total_u_factor

Get a number for the total U-Factor across the boundaries in W/m2-K.