Distribution Branch Equipment

Distribution Branch Equipment#

pydantic model gdm.distribution.equipment.SequenceImpedanceBranchEquipment#

Data model for sequence impedance branch.

Show JSON schema
{
   "title": "SequenceImpedanceBranchEquipment",
   "description": "Data model for sequence impedance branch.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "pos_seq_resistance": {
         "default": null,
         "description": "Per unit length positive sequence resistance.",
         "title": "Pos Seq Resistance",
         "type": "string"
      },
      "zero_seq_resistance": {
         "default": null,
         "description": "Per unit length zero sequence impedance.",
         "title": "Zero Seq Resistance",
         "type": "string"
      },
      "pos_seq_reactance": {
         "default": null,
         "description": "Per unit length positive sequence impedance.",
         "title": "Pos Seq Reactance",
         "type": "string"
      },
      "zero_seq_reactance": {
         "default": null,
         "description": "Per unit length zero sequence impedance.",
         "title": "Zero Seq Reactance",
         "type": "string"
      },
      "pos_seq_capacitance": {
         "default": null,
         "description": "Per unit length positive sequence capacitance.",
         "title": "Pos Seq Capacitance",
         "type": "string"
      },
      "zero_seq_capacitance": {
         "default": null,
         "description": "Per unit length zero sequence capacitance.",
         "title": "Zero Seq Capacitance",
         "type": "string"
      },
      "ampacity": {
         "default": null,
         "description": "Ampacity of the conductor.",
         "title": "Ampacity",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "pos_seq_resistance",
      "zero_seq_resistance",
      "pos_seq_reactance",
      "zero_seq_reactance",
      "pos_seq_capacitance",
      "zero_seq_capacitance",
      "ampacity"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

  • ampacity (infrasys.quantities.Current)

  • pos_seq_capacitance (gdm.quantities.CapacitancePULength)

  • pos_seq_reactance (gdm.quantities.ReactancePULength)

  • pos_seq_resistance (gdm.quantities.ResistancePULength)

  • zero_seq_capacitance (gdm.quantities.CapacitancePULength)

  • zero_seq_reactance (gdm.quantities.ReactancePULength)

  • zero_seq_resistance (gdm.quantities.ResistancePULength)

field ampacity: ', metadata=[Gt(gt=0)])] [Required]#

Ampacity of the conductor.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

  • gt = 0

field pos_seq_capacitance: ')] [Required]#

Per unit length positive sequence capacitance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field pos_seq_reactance: ')] [Required]#

Per unit length positive sequence impedance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field pos_seq_resistance: ')] [Required]#

Per unit length positive sequence resistance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field zero_seq_capacitance: ')] [Required]#

Per unit length zero sequence capacitance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field zero_seq_reactance: ')] [Required]#

Per unit length zero sequence impedance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field zero_seq_resistance: ')] [Required]#

Per unit length zero sequence impedance.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

pydantic model gdm.distribution.equipment.MatrixImpedanceBranchEquipment#

Show JSON schema
{
   "title": "MatrixImpedanceBranchEquipment",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "construction": {
         "default": "OVERHEAD",
         "description": "Construction type of MatrixImpedanceBranchEquipmentBase.",
         "type": "string"
      },
      "r_matrix": {
         "default": "OVERHEAD",
         "description": "Per unit length resistance matrix.",
         "title": "R Matrix",
         "type": "string"
      },
      "x_matrix": {
         "default": "OVERHEAD",
         "description": "Per unit length reactance matrix.",
         "title": "X Matrix",
         "type": "string"
      },
      "c_matrix": {
         "default": "OVERHEAD",
         "description": "Per unit length capacitance matrix.",
         "title": "C Matrix",
         "type": "string"
      },
      "ampacity": {
         "default": "OVERHEAD",
         "description": "Ampacity of the conductor.",
         "title": "Ampacity",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "r_matrix",
      "x_matrix",
      "c_matrix",
      "ampacity"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

Validators:

pydantic model gdm.distribution.equipment.GeometryBranchEquipment#

Data model for geometry branch info.

Show JSON schema
{
   "title": "GeometryBranchEquipment",
   "description": "Data model for geometry branch info.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "conductors": {
         "description": "List of overhead wires or cables.",
         "items": {
            "anyOf": [
               {
                  "$ref": "#/$defs/BareConductorEquipment"
               },
               {
                  "$ref": "#/$defs/ConcentricCableEquipment"
               }
            ]
         },
         "title": "Conductors",
         "type": "array"
      },
      "horizontal_positions": {
         "default": "OVERHEAD",
         "description": "Horizontal position of the conductor.",
         "title": "Horizontal Positions",
         "type": "string"
      },
      "vertical_positions": {
         "default": "OVERHEAD",
         "description": "Vertical position of the conductor.",
         "title": "Vertical Positions",
         "type": "string"
      }
   },
   "$defs": {
      "BareConductorEquipment": {
         "additionalProperties": false,
         "description": "Data model for conductor catalaog.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "conductor_diameter": {
               "default": "OVERHEAD",
               "description": "Diameter of the conductor.",
               "title": "Conductor Diameter",
               "type": "string"
            },
            "conductor_gmr": {
               "default": "OVERHEAD",
               "description": "Geometric mean radius of the conductor.",
               "title": "Conductor Gmr",
               "type": "string"
            },
            "ampacity": {
               "default": "OVERHEAD",
               "description": "Ampacity of the conductor.",
               "title": "Ampacity",
               "type": "string"
            },
            "ac_resistance": {
               "default": "OVERHEAD",
               "description": "Per unit length positive alternating current resistance of the conductor.",
               "title": "Ac Resistance",
               "type": "string"
            },
            "emergency_ampacity": {
               "default": "OVERHEAD",
               "description": "Emergency ampacity for this conductor.",
               "title": "Emergency Ampacity",
               "type": "string"
            },
            "dc_resistance": {
               "default": "OVERHEAD",
               "description": "Per unit length positive direct current resistance of the conductor.",
               "title": "Dc Resistance",
               "type": "string"
            }
         },
         "required": [
            "name",
            "conductor_diameter",
            "conductor_gmr",
            "ampacity",
            "ac_resistance",
            "emergency_ampacity",
            "dc_resistance"
         ],
         "title": "BareConductorEquipment",
         "type": "object"
      },
      "ConcentricCableEquipment": {
         "additionalProperties": false,
         "description": "Data model for cable catalog.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "strand_diameter": {
               "default": "OVERHEAD",
               "description": "Diameter of the cable strand.",
               "title": "Strand Diameter",
               "type": "string"
            },
            "conductor_diameter": {
               "default": "OVERHEAD",
               "description": "Diameter of the conductor inside cable.",
               "title": "Conductor Diameter",
               "type": "string"
            },
            "cable_diameter": {
               "default": "OVERHEAD",
               "description": "Diameter of the cable.",
               "title": "Cable Diameter",
               "type": "string"
            },
            "insulation_thickness": {
               "default": "OVERHEAD",
               "description": "Thickness of insulation.",
               "title": "Insulation Thickness",
               "type": "string"
            },
            "insulation_diameter": {
               "default": "OVERHEAD",
               "description": "Diameter of the insulation.",
               "title": "Insulation Diameter",
               "type": "string"
            },
            "ampacity": {
               "default": "OVERHEAD",
               "description": "Ampacity of the conductor.",
               "title": "Ampacity",
               "type": "string"
            },
            "conductor_gmr": {
               "default": "OVERHEAD",
               "description": "Geometric mean radius of the conductor.",
               "title": "Conductor Gmr",
               "type": "string"
            },
            "strand_gmr": {
               "default": "OVERHEAD",
               "description": "Geometric mean radius of the strand.",
               "title": "Strand Gmr",
               "type": "string"
            },
            "phase_ac_resistance": {
               "default": "OVERHEAD",
               "description": "Per unit length conductor ac resistance.",
               "title": "Phase Ac Resistance",
               "type": "string"
            },
            "strand_ac_resistance": {
               "default": "OVERHEAD",
               "description": "Per unit length ac resistance of the strand.",
               "title": "Strand Ac Resistance",
               "type": "string"
            },
            "num_neutral_strands": {
               "description": "Number of neutral strands in the cable.",
               "exclusiveMinimum": 0,
               "title": "Num Neutral Strands",
               "type": "integer"
            },
            "rated_voltage": {
               "default": "OVERHEAD",
               "description": "Rated voltage for the cable.",
               "title": "Rated Voltage",
               "type": "string"
            }
         },
         "required": [
            "name",
            "strand_diameter",
            "conductor_diameter",
            "cable_diameter",
            "insulation_thickness",
            "insulation_diameter",
            "ampacity",
            "conductor_gmr",
            "strand_gmr",
            "phase_ac_resistance",
            "strand_ac_resistance",
            "num_neutral_strands",
            "rated_voltage"
         ],
         "title": "ConcentricCableEquipment",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "conductors",
      "horizontal_positions",
      "vertical_positions"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

  • conductors (list[gdm.distribution.equipment.bare_conductor_equipment.BareConductorEquipment | gdm.distribution.equipment.concentric_cable_equipment.ConcentricCableEquipment])

  • horizontal_positions (infrasys.quantities.Distance)

  • vertical_positions (infrasys.quantities.Distance)

Validators:

  • validate_fields » all fields

field conductors: Annotated[list[BareConductorEquipment | ConcentricCableEquipment], FieldInfo(annotation=NoneType, required=True, description='List of overhead wires or cables.')] [Required]#

List of overhead wires or cables.

Validated by:

  • validate_fields

field horizontal_positions: ')] [Required]#

Horizontal position of the conductor.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

Validated by:

  • validate_fields

field vertical_positions: ')] [Required]#

Vertical position of the conductor.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

Validated by:

  • validate_fields

Contents