Distribution Switch

pydantic model gdm.distribution.components.MatrixImpedanceSwitch

Data model for matrix impedance switch.

Show JSON schema

{
   "title": "MatrixImpedanceSwitch",
   "description": "Data model for matrix impedance switch.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "substation": {
         "anyOf": [
            {
               "$ref": "#/$defs/DistributionSubstation"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the substation."
      },
      "feeder": {
         "anyOf": [
            {
               "$ref": "#/$defs/DistributionFeeder"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the feeder."
      },
      "in_service": {
         "default": true,
         "description": "Is the component in service?",
         "title": "In Service",
         "type": "boolean"
      },
      "buses": {
         "description": "List of buses connecting a branch.",
         "items": {
            "$ref": "#/$defs/DistributionBus"
         },
         "title": "Buses",
         "type": "array"
      },
      "length": {
         "default": "OVERHEAD",
         "description": "Length of the branch.",
         "title": "Length",
         "type": "string"
      },
      "phases": {
         "description": "List of phases in the same order as conductors.",
         "items": {
            "$ref": "#/$defs/Phase"
         },
         "title": "Phases",
         "type": "array"
      },
      "is_closed": {
         "description": "Status of branch for each phase.",
         "items": {
            "type": "boolean"
         },
         "title": "Is Closed",
         "type": "array"
      },
      "equipment": {
         "$ref": "#/$defs/MatrixImpedanceSwitchEquipment",
         "description": "Matrix impedance branch equipment."
      }
   },
   "$defs": {
      "DistributionBus": {
         "additionalProperties": false,
         "description": "Data model for distribution bus.\n\nExamples:\n    >>> from gdm import DistributionBus\n    >>> DistributionBus.example()",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "substation": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DistributionSubstation"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the substation."
            },
            "feeder": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DistributionFeeder"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the feeder."
            },
            "in_service": {
               "default": true,
               "description": "Is the component in service?",
               "title": "In Service",
               "type": "boolean"
            },
            "voltage_type": {
               "$ref": "#/$defs/VoltageTypes",
               "description": "Voltage types for buses."
            },
            "phases": {
               "description": "List of phases for this bus.",
               "items": {
                  "$ref": "#/$defs/Phase"
               },
               "title": "Phases",
               "type": "array"
            },
            "voltagelimits": {
               "default": [],
               "description": "List of voltage limit sets for this bus.",
               "items": {
                  "$ref": "#/$defs/VoltageLimitSet"
               },
               "title": "Voltagelimits",
               "type": "array"
            },
            "rated_voltage": {
               "default": "OVERHEAD",
               "description": "rated voltage for this bus.",
               "title": "Rated Voltage",
               "type": "string"
            },
            "coordinate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Location"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Coordinate for the power system bus."
            }
         },
         "required": [
            "name",
            "voltage_type",
            "phases",
            "rated_voltage"
         ],
         "title": "DistributionBus",
         "type": "object"
      },
      "DistributionFeeder": {
         "additionalProperties": false,
         "description": "Class interface for distribution feeder.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "title": "DistributionFeeder",
         "type": "object"
      },
      "DistributionSubstation": {
         "additionalProperties": false,
         "description": "Class interface for distribution feeder.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "feeders": {
               "description": "List of feeders for this substation.",
               "items": {
                  "$ref": "#/$defs/DistributionFeeder"
               },
               "title": "Feeders",
               "type": "array"
            }
         },
         "required": [
            "name",
            "feeders"
         ],
         "title": "DistributionSubstation",
         "type": "object"
      },
      "DistributionSwitchController": {
         "additionalProperties": false,
         "description": "Data model for distribution switch controller.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "default": "",
               "description": "Name of the switch controller.",
               "title": "Name",
               "type": "string"
            },
            "delay": {
               "default": "OVERHEAD",
               "description": "Fixed delay added to the recloser trip time.",
               "title": "Delay",
               "type": "string"
            },
            "normal_state": {
               "description": "Action to open or close the switch after delay time.",
               "enum": [
                  "open",
                  "close"
               ],
               "title": "Normal State",
               "type": "string"
            },
            "is_locked": {
               "description": "Boolean value representing whether the switch is locked or not.",
               "title": "Is Locked",
               "type": "boolean"
            }
         },
         "required": [
            "delay",
            "normal_state",
            "is_locked"
         ],
         "title": "DistributionSwitchController",
         "type": "object"
      },
      "LimitType": {
         "description": "Operational limit types.",
         "enum": [
            "min",
            "max"
         ],
         "title": "LimitType",
         "type": "string"
      },
      "Location": {
         "additionalProperties": false,
         "description": "Specifies geographic location.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "default": "",
               "title": "Name",
               "type": "string"
            },
            "x": {
               "title": "X",
               "type": "number"
            },
            "y": {
               "title": "Y",
               "type": "number"
            },
            "crs": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Crs"
            }
         },
         "required": [
            "x",
            "y"
         ],
         "title": "Location",
         "type": "object"
      },
      "MatrixImpedanceSwitchEquipment": {
         "additionalProperties": false,
         "description": "Data model for matrix impedance based recloser equipment.",
         "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"
            },
            "controller": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DistributionSwitchController"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional controller for this switch."
            }
         },
         "required": [
            "name",
            "r_matrix",
            "x_matrix",
            "c_matrix",
            "ampacity"
         ],
         "title": "MatrixImpedanceSwitchEquipment",
         "type": "object"
      },
      "Phase": {
         "description": "This class is used to represent a single phase from a set of possible values.",
         "enum": [
            "A",
            "B",
            "C",
            "N",
            "S1",
            "S2"
         ],
         "title": "Phase",
         "type": "string"
      },
      "VoltageLimitSet": {
         "additionalProperties": false,
         "description": "Data model for voltage limit set.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "default": "",
               "description": "Name of the voltage limit set.",
               "title": "Name",
               "type": "string"
            },
            "limit_type": {
               "$ref": "#/$defs/LimitType",
               "description": "Limit type used."
            },
            "value": {
               "default": "OVERHEAD",
               "description": "Voltage threshold.",
               "title": "Value",
               "type": "string"
            }
         },
         "required": [
            "limit_type",
            "value"
         ],
         "title": "VoltageLimitSet",
         "type": "object"
      },
      "VoltageTypes": {
         "description": "Identifier of voltage types referenced in distribution models.",
         "enum": [
            "line-to-line",
            "line-to-ground"
         ],
         "title": "VoltageTypes",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "buses",
      "length",
      "phases",
      "is_closed",
      "equipment"
   ]
}

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:

• buses (list[gdm.distribution.components.distribution_bus.DistributionBus])

• equipment (gdm.distribution.equipment.matrix_impedance_switch_equipment.MatrixImpedanceSwitchEquipment)

• feeder (gdm.distribution.components.distribution_feeder.DistributionFeeder | None)

• in_service (bool)

• is_closed (list[bool])

• length (infrasys.quantities.Distance)

• name (str)

• phases (list[gdm.distribution.enums.Phase])

• substation (gdm.distribution.components.distribution_substation.DistributionSubstation | None)

• uuid (uuid.UUID)

Validators:

• validate_fields » all fields

• validate_fields_base » all fields

field buses: Annotated[list[DistributionBus], Field(..., description='List of buses connecting a branch.')] [Required]

List of buses connecting a branch.

Validated by:

• validate_fields

• validate_fields_base

field equipment: Annotated[MatrixImpedanceSwitchEquipment, FieldInfo(annotation=NoneType, required=True, description='Matrix impedance branch equipment.')] [Required]

Matrix impedance branch equipment.

Validated by:

• validate_fields

• validate_fields_base

field feeder: Annotated[DistributionFeeder | None, Field(None, description='Name of the feeder.')] = None

Name of the feeder.

Validated by:

• validate_fields

• validate_fields_base

field in_service: Annotated[bool, Field(True, description='Is the component in service?')] = True

Is the component in service?

Validated by:

• validate_fields

• validate_fields_base

field is_closed: Annotated[list[bool], Field(description='Status of branch for each phase.')] [Required]

Status of branch for each phase.

Validated by:

• validate_fields

• validate_fields_base

field length: Annotated[Distance, PINT_SCHEMA, Field(..., description='Length of the branch.', gt=0)] [Required]

Length of the branch.

Constraints:

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

• gt = 0

Validated by:

• validate_fields

• validate_fields_base

field phases: Annotated[list[Phase], Field(..., description='List of phases in the same order as conductors.')] [Required]

List of phases in the same order as conductors.

Validated by:

• validate_fields

• validate_fields_base

field substation: Annotated[DistributionSubstation | None, Field(None, description='Name of the substation.')] = None

Name of the substation.

Validated by:

• validate_fields

• validate_fields_base

validator validate_fields_base  »  all fields

Custom validator for distribution switch.