piel.types.electrical.cables

piel.types.electrical.cables#

Attributes#

`CableHeatTransferTypes`
`CableGeometryTypes`
`CableMaterialSpecificationTypes`
`CableTypes`

Classes#

`CoaxialCableGeometryType`	A base model class that serves as the foundation for other measurement in the project.
`CoaxialCableHeatTransferType`	All units are in watts.
`CoaxialCableMaterialSpecificationType`	A base model class that serves as the foundation for other measurement in the project.
`DCCableGeometryType`	A base model class that serves as the foundation for other measurement in the project.
`DCCableHeatTransferType`	All units are in watts.
`DCCableMaterialSpecificationType`	A base model class that serves as the foundation for other measurement in the project.
`Cable`	Represents the data of a physical component or device.
`DCCable`	A DC cable is a single core cable that is used to transmit direct current.
`CoaxialCable`	A coaxial cable is a type of electrical cable that has an inner conductor surrounded by a tubular insulating layer,

Module Contents#

class CoaxialCableGeometryType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

A base model class that serves as the foundation for other measurement in the project. This class extends pydantic’s BaseModel and includes additional configuration settings for strict validation and immutability.

Config#: A nested class to configure the behavior of the model. arbitrary_types_allowed (bool): Allows arbitrary measurement. extra (str): Forbids extra attributes not defined in the model. validate_assignment (bool): Validates fields on assignment. strict (bool): Enforces strict type validation. allow_mutation (bool): Prevents mutation of the model’s fields.

supplied_parameters() → list[str]#: Returns a list of parameter names that have been supplied (i.e., are not None).

core_cross_sectional_area_m2: float | None = 0#: The cross-sectional area of the core in meters squared.

length_m: float = 0#: The length of the cable in meters.

sheath_cross_sectional_area_m2: float | None = 0#: The cross-sectional area of the sheath in meters squared.

total_cross_sectional_area_m2: float | None = 0#: The total cross-sectional area of the cable in meters squared.

class CoaxialCableHeatTransferType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

All units are in watts.

core: float | None = 0#: The computed heat transfer in watts for the core of the cable.

sheath: float | None = 0#: The computed heat transfer in watts for the sheath of the cable.

dielectric: float | None = 0#: The computed heat transfer in watts for the dielectric of the cable.

total: float = 0#: The total computed heat transfer in watts for the cable.

units: str = 'W'#

class CoaxialCableMaterialSpecificationType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

Config#: A nested class to configure the behavior of the model. arbitrary_types_allowed (bool): Allows arbitrary measurement. extra (str): Forbids extra attributes not defined in the model. validate_assignment (bool): Validates fields on assignment. strict (bool): Enforces strict type validation. allow_mutation (bool): Prevents mutation of the model’s fields.

supplied_parameters() → list[str][source]#: Returns a list of parameter names that have been supplied (i.e., are not None).

core: piel.types.materials.MaterialReferenceType | None = None#: The material of the core.

sheath: piel.types.materials.MaterialReferenceType | None = None#: The material of the sheath.

dielectric: piel.types.materials.MaterialReferenceType | None = None#: The material of the dielectric.

supplied_parameters()[source]#

Returns a list of parameter names that have been supplied (i.e., are not None).

Returns:: A list of parameter names with non-None values.
Return type:: list[str]

class DCCableGeometryType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

Config#: A nested class to configure the behavior of the model. arbitrary_types_allowed (bool): Allows arbitrary measurement. extra (str): Forbids extra attributes not defined in the model. validate_assignment (bool): Validates fields on assignment. strict (bool): Enforces strict type validation. allow_mutation (bool): Prevents mutation of the model’s fields.

supplied_parameters() → list[str]#: Returns a list of parameter names that have been supplied (i.e., are not None).

core_cross_sectional_area_m2: float = 0#: The cross-sectional area of the core in meters squared.

length_m: float = 0#: The length of the cable in meters.

total_cross_sectional_area_m2: float = 0#: The total cross-sectional area of the cable in meters squared.

class DCCableHeatTransferType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

All units are in watts.

core: float | None = 0#: The computed heat transfer in watts for the core of the cable.

total: float = 0#: The total computed heat transfer in watts for the cable.

units: str = 'W'#

class DCCableMaterialSpecificationType(/, **data: Any)[source]#

Bases: piel.types.quantity.Quantity

Config#: A nested class to configure the behavior of the model. arbitrary_types_allowed (bool): Allows arbitrary measurement. extra (str): Forbids extra attributes not defined in the model. validate_assignment (bool): Validates fields on assignment. strict (bool): Enforces strict type validation. allow_mutation (bool): Prevents mutation of the model’s fields.

supplied_parameters() → list[str]#: Returns a list of parameter names that have been supplied (i.e., are not None).

core: piel.types.materials.MaterialReferenceType | None = None#: The material of the core.

class Cable(/, **data: Any)[source]#

Bases: piel.types.connectivity.physical.PhysicalComponent

Represents the data of a physical component or device.

class DCCable(/, **data: Any)[source]#

Bases: Cable

A DC cable is a single core cable that is used to transmit direct current.

geometry: DCCableGeometryType | None = None#

heat_transfer: DCCableHeatTransferType | None = None#

material_specification: DCCableMaterialSpecificationType | None = None#

class CoaxialCable(/, **data: Any)[source]#

Bases: piel.types.radio_frequency.RFPhysicalComponent

A coaxial cable is a type of electrical cable that has an inner conductor surrounded by a tubular insulating layer, surrounded by a tubular conducting shield.

geometry: CoaxialCableGeometryType | None#

heat_transfer: CoaxialCableHeatTransferType | None = None#

material_specification: CoaxialCableMaterialSpecificationType | None = None#

CableHeatTransferTypes#

CableGeometryTypes#

CableMaterialSpecificationTypes#

CableTypes#