dragonfly_energy.opendss.wire module¶
Wire in OpenDSS.
- class dragonfly_energy.opendss.wire.ConcentricProperties(geometrical_mean_radius=0.8, resistance=5.8, concentric_strand_diameter=2, concentric_outside_diameter=45, strand_count=24)[source]¶
Bases:
object
Represents the concentric neutral properties of a wire in OpenDSS.
- Parameters
geometrical_mean_radius – A number for the geometric mean of distances between the neutral strands in millimeters. (Default: 0.8).
resistance – A number for the electrical resistance of the neutral strands in ohms per kilometer of wire. (Default: 5.8).
concentric_strand_diameter – A number for the diameter of the neutral strand in millimeters. (Default: 2).
concentric_outside_diameter – A number for the outside diameter of the neutral strand in millimeters. (Default: 45).
strand_count – A positive integer for the number of concentric neutral strands. (Default: 24)
- Properties:
geometrical_mean_radius
resistance
concentric_strand_diameter
concentric_outside_diameter
strand_count
- classmethod from_dict(data)[source]¶
Create a ConcentricProperties object from a dictionary.
- Parameters
data – A dictionary representation of a ConcentricProperties object in the format below.
{ 'type': 'ConcentricProperties', 'geometrical_mean_radius': 0.8, # gmr in mm 'resistance': 5.8, # resistance of the wire in ohms/km 'concentric_strand_diameter': 2, # diameter of the wire in mm 'concentric_outside_diameter': 45, # outside diameter of the wire in mm 'strand_count': 24 # integer for the number of strands }
- lock()¶
- unlock()¶
- property concentric_outside_diameter¶
Get or set a number for the outside diameter of the neutral strand in mm.
- property concentric_strand_diameter¶
Get or set a number for the diameter of the neutral strand in mm.
- property geometrical_mean_radius¶
Get or set a number for the geometrical mean radius of the strands in mm.
- property resistance¶
Get or set a number for the resistance of the strands in ohms per km of wire.
- property strand_count¶
Get or set a positive integer for the number of concentric neutral strands.
- class dragonfly_energy.opendss.wire.Wire(identifier, ampacity=220, geometrical_mean_radius=3.9, resistance=0.3937, diameter=10, voltage_level='MV', wire_type='OH', concentric_properties=None)[source]¶
Bases:
object
Represents the properties of a wire in OpenDSS.
- Parameters
identifier – Text string for a unique wire property ID. Must contain only characters that are acceptable in OpenDSS. This will be used to identify the object across the exported geoJSON and OpenDSS files.
ampacity – A number for the ampacity of the wire in amps. (Default: 220).
geometrical_mean_radius – A number for the geometric mean of distances between the strands of the conductor in millimeters. (Default: 3.9).
resistance – A number for the electrical resistance of the conductor in ohms per kilometer of wire. (Default: 0.3937).
diameter – A number for the diameter of the wire in millimeters. (Default: 10).
voltage_level – Text to denote the level of voltage that the wire is designed to carry. Choose from (“LV”, “MV”, “LV or MV”). (Default: “MV”).
wire_type – Text for the type of wire, denoting whether the wire is overhead (OH) or underground (UG). Choose from (‘OH’, ‘UG’, ‘UG concentric neutral’). (Default: “OH”).
concentric_properties – A ConcentricProperties object to denote the concentric neutral properties of the Wire. This must be specified when the wire_type is “UG concentric neutral.” (Default: None).
- Properties:
identifier
display_name
ampacity
geometrical_mean_radius
resistance
diameter
voltage_level
wire_type
concentric_properties
- classmethod from_dict(data)[source]¶
Create a Wire object from a dictionary.
- Parameters
data – A dictionary representation of a Wire object in the format below.
{ 'type': 'Wire', 'identifier': 'OH AL 2/0 A', # unique wire property identifier 'ampacity': 220, # ampacity of the wire in amps 'geometrical_mean_radius': 3.9, # gmr in mm 'resistance': 0.3937, # resistance of the wire in ohms/km 'diameter': 10, # diameter of the wire in mm 'voltage_level': 'LV or MV', # text for the voltage level 'wire_type': 'OH' # text for the type of wire }
- classmethod from_electrical_database_dict(data)[source]¶
Create a Wire from an dictionary as it appears in electrical_database.json.
- Parameters
data – A dictionary representation of a Wire object in the format below.
{ 'nameclass': 'OH AL 2/0 A', # unique wire property identifier 'ampacity (A)': 220, # ampacity of the wire in amps 'gmr (mm)': 3.9, # gmr in meters 'resistance (ohm/km)': 0.3937, # resistance of the wire in ohms/km 'diameter (mm)': 10, # diameter of the wire in meters 'voltage level': 'MV', 'type': 'OH' }
- to_electrical_database_dict()[source]¶
Get Wire as it should appear in the URBANopt electrical database.json.
- VALID_VOLTAGE_LEVELS = ('LV', 'MV', 'LV or MV')¶
- VALID_WIRE_TYPES = ('OH', 'UG', 'UG concentric neutral')¶
- property ampacity¶
Get or set a number for the ampacity of the wire in amps.
- property concentric_properties¶
Get or set an array of Wire objects for the phases of the wires.
- property diameter¶
Get or set a number for the diameter of the wire in mm.
- 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 geometrical_mean_radius¶
Get or set a number for the geometrical mean radius of the wire in mm.
- property identifier¶
Get or set a text string for the unique object identifier.
- property resistance¶
Get or set a number for the resistance of the wire in ohms per km of wire.
- property voltage_level¶
Get or set text for the voltage level of the wire. (LV, MV, LV or MV).
- property wire_type¶
Get or set a text string for the type of wire.