Distribution Branch#

pydantic model gdm.SequenceImpedanceBranch#

Interface for sequence impedance branch.

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

List of buses connecting a branch.

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

Sequence impedance branch.

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

Name of the feeder.

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

Is the component in service?

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

Length of the branch.

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.

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

Name of the substation.

validator validate_fields_base  »  all fields#

Custom validator for base distribution branch.

pydantic model gdm.MatrixImpedanceBranch#

Interface for matrix impedance branch.

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

List of buses connecting a branch.

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

Matrix impedance branch equipment.

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

Name of the feeder.

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

Is the component in service?

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

Length of the branch.

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.

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

Name of the substation.

validator validate_fields_base  »  all fields#

Custom validator for base distribution branch.

pydantic model gdm.GeometryBranch#

Interface for geometry based lines.

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

List of buses connecting a branch.

field equipment: Annotated[GeometryBranchEquipment, FieldInfo(annotation=NoneType, required=True, description='Geometry branch equipment.')] [Required]#

Geometry branch equipment.

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

Name of the feeder.

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

Is the component in service?

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

Length of the branch.

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.

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

Name of the substation.

validator validate_fields_base  »  all fields#

Custom validator for base distribution branch.