dragonfly_energy.des.connector module

Thermal connector in a District Energy System.

class dragonfly_energy.des.connector.HorizontalPipeParameter(buried_depth=1.5, diameter_ratio=11, pressure_drop_per_meter=300, insulation_conductivity=3.0, insulation_thickness=0.2, heat_capacity=2139000, roughness=1e-06)[source]

Bases: object

Represents the properties of horizontal pipes contained within ThermalConnectors.

Parameters:

  • buried_depth – The buried depth of the pipes in meters. (Default: 1.5)

  • diameter_ratio – A number for the ratio of pipe outer diameter to pipe wall thickness. (Default: 11).

  • pressure_drop_per_meter – A number for the pressure drop in pascals per meter of pipe. (Default: 300).

  • insulation_conductivity – A positive number for the conductivity of the pipe insulation material in W/m-K. If no insulation exists, this value should be a virtual insulation layer of soil since this value must be greater than zero. (Default: 3.0).

  • insulation_thickness – A positive number for the thickness of pipe insulation in meters. If no insulation exists, this value should be a virtual insulation layer of soil since this value must be greater than zero. (Default: 0.2)

  • heat_capacity – A number for the volumetric heat capacity of the pipe wall material in J/m3-K. (Default: 2,139,000).

  • roughness – A number for the linear dimension of bumps on the pipe surface in meters. (Default: 1e-06)

Properties:

  • buried_depth

  • diameter_ratio

  • pressure_drop_per_meter

  • insulation_conductivity

  • insulation_thickness

  • heat_capacity

  • roughness

ToString()[source]

Overwrite .NET ToString method.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a HorizontalPipeParameter object from a dictionary

Parameters:

data – A dictionary representation of an HorizontalPipeParameter object in the format below.

{
'type': 'HorizontalPipeParameter',
'buried_depth': 2.0,  # float for buried depth in meters
'diameter_ratio': 11,  # float for diameter ratio
'pressure_drop_per_meter': 250, # float for pressure drop in Pa/m
'insulation_conductivity': 0.6,  # float in W/m2-K
'insulation_thickness': 0.3,  # float for thickness in meters
'heat_capacity': 1542000,  # float in J/m3-K
'roughness': 1e-06  # float for the dimension of the surface bumps in meters
}
to_dict()[source]

Get HorizontalPipeParameter dictionary.

property buried_depth

Get or set a number for the buried depth of the pipes in meters.

property diameter_ratio

Get or set a number for the ratio of pipe outer diameter to pipe wall thickness.

property heat_capacity

Get or set a number for the volumetric heat capacity of the pipe in J/m3-K.

property insulation_conductivity

Get or set a number for the conductivity of the insulation material in W/m-K.

property insulation_thickness

Get or set a number for the thickness of the insulation material in meters.

property pressure_drop_per_meter

Get or set a number for the pressure drop in pascals per meter of pipe.

property roughness

Get or set a number for the dimension of the pipe surface bumps in meters.

class dragonfly_energy.des.connector.ThermalConnector(identifier, geometry)[source]

Bases: _GeometryBase

Represents a thermal connector carrying hot, chilled or ambient water in a DES.

Parameters:

  • identifier – Text string for a unique thermal connector ID. Must contain only characters that are acceptable in a DES. This will be used to identify the object across the exported geoJSON and DES files.

  • geometry – A LineSegment2D or Polyline2D representing the geometry of the thermal connector.

Properties:

  • identifier

  • display_name

  • geometry

ToString()
duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Initialize an ThermalConnector from a dictionary.

Parameters:

data – A dictionary representation of an ThermalConnector object.

classmethod from_dict_abridged(data)[source]

Initialize an ThermalConnector from an abridged dictionary.

Parameters:

data – A ThermalConnector dictionary.

classmethod from_geojson_dict(data, origin_lon_lat, conversion_factors)[source]

Get a ThermalConnector from a dictionary as it appears in a GeoJSON.

Parameters:

  • data – A GeoJSON dictionary representation of an ThermalConnector feature.

  • origin_lon_lat – An array of two numbers in degrees. The first value represents the longitude of the scene origin in degrees (between -180 and +180). The second value represents latitude of the scene origin in degrees (between -90 and +90). Note that the “scene origin” is the (0, 0) coordinate in the 2D space of the input polygon.

  • conversion_factors – A tuple with two values used to translate between meters and longitude, latitude.

move(moving_vec)

Move this object along a vector.

Parameters:

moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the object.

reflect(plane)

Reflect this object across a plane.

Parameters:

plane – A ladybug_geometry Plane across which the object will be reflected.

reverse()[source]

Reverse the direction of this object’s geometry.

This is useful when trying to orient the connector to the direction of flow within a larger loop.

rotate_xy(angle, origin)

Rotate this object counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle – An angle in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor, origin=None)

Scale this object by a factor from an origin point.

Parameters:

  • factor – A number representing how much the object should be scaled.

  • origin – A ladybug_geometry Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict()[source]

ThermalConnector dictionary representation.

to_geojson_dict(start_id, end_id, origin_lon_lat, conversion_factors, start_feature_id=None, end_feature_id=None)[source]

Get ThermalConnector dictionary as it appears in an URBANopt geoJSON.

Parameters:

  • start_id – Identifier of the junction at the start of the pipe.

  • end_id – Identifier of the junction at the end of the pipe.

  • origin_lon_lat – An array of two numbers in degrees. The first value represents the longitude of the scene origin in degrees (between -180 and +180). The second value represents latitude of the scene origin in degrees (between -90 and +90). Note that the “scene origin” is the (0, 0) coordinate in the 2D space of the input polygon.

  • conversion_factors – A tuple with two values used to translate between meters and longitude, latitude.

  • start_feature_id – Optional identifier for a feature (Building or GHE field) at the start of the pipe.

  • end_feature_id – Optional identifier for a feature (Building or GHE field) at the end of the pipe.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property geometry

Get a LineSegment2D or Polyline2D representing the thermal connector.

property identifier

Get or set the text string for unique object identifier.