Capacitor Equipment

Capacitor Equipment#

pydantic model gdm.distribution.equipment.PhaseCapacitorEquipment#

Data model for phase capacitor.

Show JSON schema

{
   "title": "PhaseCapacitorEquipment",
   "description": "Data model for phase capacitor.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "resistance": {
         "default": "0 ohm",
         "description": "Positive resistance for the capacitor.",
         "title": "Resistance",
         "type": "string"
      },
      "reactance": {
         "default": "0 ohm",
         "description": "Positive reactance for the capacitor.",
         "title": "Reactance",
         "type": "string"
      },
      "rated_reactive_power": {
         "default": "0 ohm",
         "description": "Rated reactive power of this capacitor.",
         "title": "Rated Reactive Power",
         "type": "string"
      },
      "num_banks_on": {
         "description": "Number of banks currently on.",
         "minimum": 0,
         "title": "Num Banks On",
         "type": "integer"
      },
      "num_banks": {
         "default": 1,
         "description": "Number of banks in the capacitor.",
         "exclusiveMinimum": 0,
         "title": "Num Banks",
         "type": "integer"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "rated_reactive_power",
      "num_banks_on"
   ]
}

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:

name (str)
num_banks (int)
num_banks_on (int)
rated_reactive_power (gdm.quantities.ReactivePower)
reactance (gdm.quantities.Reactance)
resistance (infrasys.quantities.Resistance)
uuid (uuid.UUID)

Validators:

validate_fields » all fields

field num_banks: Annotated[int, Gt(gt=0), FieldInfo(annotation=NoneType, required=False, default=1, description='Number of banks in the capacitor.')] = 1#

Number of banks in the capacitor.

Constraints:

gt = 0

Validated by:

validate_fields

field num_banks_on: Annotated[int, Ge(ge=0), FieldInfo(annotation=NoneType, required=True, description='Number of banks currently on.')] [Required]#

Number of banks currently on.

Constraints:

ge = 0

Validated by:

validate_fields

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

Rated reactive power of this capacitor.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: ‘0 ohm’}
gt = 0

Validated by:

validate_fields

field reactance: ', metadata=[Ge(ge=0)])] = <Quantity(0, 'ohm')>#

Positive reactance for the capacitor.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: ‘0 ohm’}
ge = 0

Validated by:

validate_fields

field resistance: ', metadata=[Ge(ge=0)])] = <Quantity(0, 'ohm')>#

Positive resistance for the capacitor.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: ‘0 ohm’}
ge = 0

Validated by:

validate_fields

classmethod aggregate(instances: list[PhaseCapacitorEquipment], name: str) → PhaseCapacitorEquipment#

classmethod split(instance: PhaseCapacitorEquipment, num_splits: int) → PhaseCapacitorEquipment#

pydantic model gdm.distribution.equipment.CapacitorEquipment#

Data model for capacitor model.

Show JSON schema

{
   "title": "CapacitorEquipment",
   "description": "Data model for capacitor model.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "phase_capacitors": {
         "description": "List of phase capacitors for this distribution capacitor.",
         "items": {
            "$ref": "#/$defs/PhaseCapacitorEquipment"
         },
         "title": "Phase Capacitors",
         "type": "array"
      },
      "connection_type": {
         "$ref": "#/$defs/ConnectionType",
         "default": "STAR",
         "description": "Connection type for this capacitor."
      },
      "rated_voltage": {
         "description": "Rated voltage for this capacitor.",
         "gt": 0,
         "title": "Rated Voltage"
      },
      "voltage_type": {
         "$ref": "#/$defs/VoltageTypes",
         "description": "Rated voltage is line to line or line to neutral."
      }
   },
   "$defs": {
      "ConnectionType": {
         "description": "Winding connection types.",
         "enum": [
            "STAR",
            "DELTA",
            "OPEN_DELTA",
            "OPEN_STAR",
            "ZIG_ZAG"
         ],
         "title": "ConnectionType",
         "type": "string"
      },
      "PhaseCapacitorEquipment": {
         "additionalProperties": false,
         "description": "Data model for phase capacitor.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "resistance": {
               "default": "0 ohm",
               "description": "Positive resistance for the capacitor.",
               "title": "Resistance",
               "type": "string"
            },
            "reactance": {
               "default": "0 ohm",
               "description": "Positive reactance for the capacitor.",
               "title": "Reactance",
               "type": "string"
            },
            "rated_reactive_power": {
               "default": "0 ohm",
               "description": "Rated reactive power of this capacitor.",
               "title": "Rated Reactive Power",
               "type": "string"
            },
            "num_banks_on": {
               "description": "Number of banks currently on.",
               "minimum": 0,
               "title": "Num Banks On",
               "type": "integer"
            },
            "num_banks": {
               "default": 1,
               "description": "Number of banks in the capacitor.",
               "exclusiveMinimum": 0,
               "title": "Num Banks",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "rated_reactive_power",
            "num_banks_on"
         ],
         "title": "PhaseCapacitorEquipment",
         "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",
      "phase_capacitors",
      "rated_voltage",
      "voltage_type"
   ]
}

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:

connection_type (gdm.distribution.enums.ConnectionType)
name (str)
phase_capacitors (list[gdm.distribution.equipment.phase_capacitor_equipment.PhaseCapacitorEquipment])
rated_voltage (infrasys.quantities.Voltage)
uuid (uuid.UUID)
voltage_type (gdm.distribution.enums.VoltageTypes)

field connection_type: ')] = ConnectionType.STAR#: Connection type for this capacitor.

field phase_capacitors: Annotated[list[PhaseCapacitorEquipment], FieldInfo(annotation=NoneType, required=True, description='List of phase capacitors for this distribution capacitor.')] [Required]#: List of phase capacitors for this distribution capacitor.

field rated_voltage: Annotated[Voltage, FieldInfo(annotation=NoneType, required=True, description='Rated voltage for this capacitor.', metadata=[Gt(gt=0)])] [Required]#

Rated voltage for this capacitor.

Constraints:

gt = 0

field voltage_type: Annotated[VoltageTypes, FieldInfo(annotation=NoneType, required=True, description='Rated voltage is line to line or line to neutral.')] [Required]#: Rated voltage is line to line or line to neutral.

Capacitor Equipment

Contents

Capacitor Equipment#