piel.models.physical.electrical.cable

piel.models.physical.electrical.cable#

Attributes#

MaterialReferenceType

CableHeatTransferTypes

CableGeometryTypes

CableMaterialSpecificationTypes

TemperatureRangeTypes

Classes#

CoaxialCableGeometryType

The base class for all cable types.

CoaxialCableHeatTransferType

All units are in watts.

CoaxialCableMaterialSpecificationType

The base class for all cable types.

DCCableGeometryType

The base class for all cable types.

DCCableHeatTransferType

All units are in watts.

DCCableMaterialSpecificationType

The base class for all cable types.

Functions#

calculate_cross_sectional_area_m2(→ float)

Calculates the cross-sectional area of a circle in meters squared.

awg_to_cross_sectional_area_m2(→ float)

Converts an AWG value to the cross-sectional area in meters squared.

heat_transfer_1d_W(→ float)

Calculate the heat transfer in watts for a 1D system. The thermal conductivity is assumed to be a function of

get_thermal_conductivity_fit(→ piel.types.ArrayTypes)

Get the thermal conductivity fit for a given material.

calculate_coaxial_cable_geometry(...)

Calculate the geometry of a coaxial cable. Defaults are based on the parameters of a TODO

define_coaxial_cable_materials(...)

Define the materials of a coaxial cable.

calculate_coaxial_cable_heat_transfer(...)

Calculate the heat transfer of a coaxial cable.

calculate_dc_cable_geometry(...)

Calculate the geometry of a DC cable. Defaults are based on the parameters of a TODO

define_dc_cable_materials(...)

Define the materials of a coaxial cable.

calculate_dc_cable_heat_transfer(...)

Calculate the heat transfer of a coaxial cable.

Module Contents#

calculate_cross_sectional_area_m2(diameter_m: float) → float[source]#

Calculates the cross-sectional area of a circle in meters squared.

Parameters:

diameter_m (float) – Diameter of the circle in meters.

Returns:

Cross sectional area in meters squared.

Return type:

float

awg_to_cross_sectional_area_m2(awg: int) → float[source]#

Converts an AWG value to the cross-sectional area in meters squared.

Parameters:

awg (int) – The AWG value to convert.

Returns:

The cross-sectional area in meters squared.

Return type:

float

heat_transfer_1d_W(thermal_conductivity_fit, temperature_range_K: piel.models.physical.types.TemperatureRangeTypes, cross_sectional_area_m2: float, length_m: float, *args, **kwargs) → float[source]#

Calculate the heat transfer in watts for a 1D system. The thermal conductivity is assumed to be a function of temperature.

\[q = A \int_{T_1}^{T_2} k(T) dT\]
Parameters:

  • thermal_conductivity_fit –

  • temperature_range_K –

  • cross_sectional_area_m2 –

  • length_m –

Returns:

The heat transfer in watts for a 1D system.

Return type:

float

MaterialReferenceType#
get_thermal_conductivity_fit(temperature_range_K: piel.models.physical.types.TemperatureRangeTypes, material: piel.materials.thermal_conductivity.types.MaterialReferenceType, *args, **kwargs) → piel.types.ArrayTypes[source]#

Get the thermal conductivity fit for a given material.

Parameters:

  • temperature_range_K –

  • material –

Returns:

class CoaxialCableGeometryType[source]#

Bases: piel.types.QuantityType

The base class for all cable types.

core_cross_sectional_area_m2: float | None#

The cross-sectional area of the core in meters squared.

length_m: float#

The length of the cable in meters.

sheath_cross_sectional_area_m2: float | None#

The cross-sectional area of the sheath in meters squared.

total_cross_sectional_area_m2: float | None#

The total cross-sectional area of the cable in meters squared.

class CoaxialCableHeatTransferType[source]#

Bases: piel.types.QuantityType

All units are in watts.

core: float | None#

The computed heat transfer in watts for the core of the cable.

sheath: float | None#

The computed heat transfer in watts for the sheath of the cable.

dielectric: float | None#

The computed heat transfer in watts for the dielectric of the cable.

total: float#

The total computed heat transfer in watts for the cable.

class CoaxialCableMaterialSpecificationType[source]#

Bases: piel.types.QuantityType

The base class for all cable types.

core: piel.materials.thermal_conductivity.types.MaterialReferenceType | None#

The material of the core.

sheath: piel.materials.thermal_conductivity.types.MaterialReferenceType | None#

The material of the sheath.

dielectric: piel.materials.thermal_conductivity.types.MaterialReferenceType | None#

The material of the dielectric.

class DCCableGeometryType[source]#

Bases: piel.types.QuantityType

The base class for all cable types.

core_cross_sectional_area_m2: float#

The cross-sectional area of the core in meters squared.

length_m: float#

The length of the cable in meters.

total_cross_sectional_area_m2: float#

The total cross-sectional area of the cable in meters squared.

class DCCableHeatTransferType[source]#

Bases: piel.types.QuantityType

All units are in watts.

core: float | None#

The computed heat transfer in watts for the core of the cable.

total: float#

The total computed heat transfer in watts for the cable.

class DCCableMaterialSpecificationType[source]#

Bases: piel.types.QuantityType

The base class for all cable types.

core: piel.materials.thermal_conductivity.types.MaterialReferenceType | None#

The material of the core.

CableHeatTransferTypes#
CableGeometryTypes#
CableMaterialSpecificationTypes#
TemperatureRangeTypes#
calculate_coaxial_cable_geometry(length_m: float = 1, sheath_top_diameter_m: float = 0.001651, sheath_bottom_diameter_m: float = 0.001468, core_diameter_dimension: Literal['awg', 'metric'] = 'metric', core_diameter_awg: piel.models.physical.electrical.types.Optional[float] = None, core_diameter_m: float = 0.002, **kwargs) → piel.models.physical.electrical.types.CoaxialCableGeometryType[source]#

Calculate the geometry of a coaxial cable. Defaults are based on the parameters of a TODO

Parameters:

  • length_m – Length of the cable in meters.

  • sheath_top_diameter_m – Diameter of the top of the sheath in meters.

  • sheath_bottom_diameter_m – Diameter of the bottom of the sheath in meters.

  • core_diameter_dimension – Dimension of the core diameter.

  • core_diameter_awg – Core diameter in AWG.

  • core_diameter_m – Core diameter in meters.

  • **kwargs –

Returns:

The geometry of the coaxial cable.

Return type:

CoaxialCableGeometryType

define_coaxial_cable_materials(core_material: piel.models.physical.electrical.types.MaterialReferenceType, sheath_material: piel.models.physical.electrical.types.MaterialReferenceType, dielectric_material: piel.models.physical.electrical.types.MaterialReferenceType) → piel.models.physical.electrical.types.CoaxialCableMaterialSpecificationType[source]#

Define the materials of a coaxial cable.

Parameters:

  • core_material – The material of the core.

  • sheath_material – The material of the sheath.

  • dielectric_material – The material of the dielectric.

Returns:

The material specification of the coaxial cable.

Return type:

CoaxialCableMaterialSpecificationType

calculate_coaxial_cable_heat_transfer(temperature_range_K: piel.models.physical.types.TemperatureRangeTypes, geometry_class: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.CoaxialCableGeometryType], material_class: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.CoaxialCableMaterialSpecificationType], core_material: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.MaterialReferenceType] = None, sheath_material: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.MaterialReferenceType] = None, dielectric_material: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.MaterialReferenceType] = None) → piel.models.physical.electrical.types.CoaxialCableHeatTransferType[source]#

Calculate the heat transfer of a coaxial cable.

Parameters:

  • temperature_range_K – The temperature range in Kelvin.

  • geometry_class – The geometry of the cable.

  • material_class – The material of the cable.

  • core_material – The material of the core.

  • sheath_material – The material of the sheath.

  • dielectric_material – The material of the dielectric.

Returns:

The heat transfer of the cable.

Return type:

CoaxialCableHeatTransferType

calculate_dc_cable_geometry(length_m: float = 1, core_diameter_dimension: Literal['awg', 'metric'] = 'metric', core_diameter_awg: piel.models.physical.electrical.types.Optional[float] = None, core_diameter_m: float = 0.002, *args, **kwargs) → piel.models.physical.electrical.types.DCCableGeometryType[source]#

Calculate the geometry of a DC cable. Defaults are based on the parameters of a TODO

Parameters:

  • length_m – Length of the cable in meters.

  • core_diameter_dimension – Dimension of the core diameter.

  • core_diameter_awg – Core diameter in AWG.

  • core_diameter_m – Core diameter in meters.

  • **kwargs –

Returns:

The geometry of the coaxial cable.

Return type:

CoaxialCableGeometryType

define_dc_cable_materials(core_material: piel.models.physical.electrical.types.MaterialReferenceType) → piel.models.physical.electrical.types.DCCableMaterialSpecificationType[source]#

Define the materials of a coaxial cable.

Parameters:

core_material – The material of the core.

Returns:

The material specification of the dc cable.

Return type:

DCCableMaterialSpecificationType

calculate_dc_cable_heat_transfer(temperature_range_K: piel.models.physical.types.TemperatureRangeTypes, geometry_class: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.DCCableGeometryType], material_class: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.DCCableMaterialSpecificationType], core_material: piel.models.physical.electrical.types.Optional[piel.models.physical.electrical.types.MaterialReferenceType] = None) → piel.models.physical.electrical.types.DCCableHeatTransferType[source]#

Calculate the heat transfer of a coaxial cable.

Parameters:

  • temperature_range_K – The temperature range in Kelvin.

  • geometry_class – The geometry of the cable.

  • material_class – The material of the cable.

  • core_material – The material of the core.

Returns:

The heat transfer of the cable.

Return type:

DCCableHeatTransferType

Contents