piel.models.physical.electrical.cables.dc
=========================================

.. py:module:: piel.models.physical.electrical.cables.dc


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/models/physical/electrical/cables/dc/common/index
   /autoapi/piel/models/physical/electrical/cables/dc/generic/index
   /autoapi/piel/models/physical/electrical/cables/dc/geometry/index
   /autoapi/piel/models/physical/electrical/cables/dc/materials/index
   /autoapi/piel/models/physical/electrical/cables/dc/thermal/index


Functions
---------

.. autoapisummary::

   piel.models.physical.electrical.cables.dc.generic_banana
   piel.models.physical.electrical.cables.dc.calculate_dc_cable_geometry
   piel.models.physical.electrical.cables.dc.define_dc_cable_materials
   piel.models.physical.electrical.cables.dc.calculate_dc_cable_heat_transfer


Package Contents
----------------

.. py:function:: generic_banana(name: str, length_m: float, **kwargs) -> piel.types.DCCable

.. py:function:: calculate_dc_cable_geometry(length_m: float = 1, core_diameter_dimension: Literal['awg', 'metric'] = 'metric', core_diameter_awg: float = 0.0, core_diameter_m: float = 0.002, *args, **kwargs) -> piel.types.electrical.cables.DCCableGeometryType

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

   :param length_m: Length of the cable in meters.
   :param core_diameter_dimension: Dimension of the core diameter.
   :param core_diameter_awg: Core diameter in AWG.
   :param core_diameter_m: Core diameter in meters.
   :param \*\*kwargs:

   :returns: The geometry of the coaxial cable.
   :rtype: CoaxialCableGeometryType


.. py:function:: define_dc_cable_materials(core_material: piel.types.materials.MaterialReferenceType) -> piel.types.electrical.cables.DCCableMaterialSpecificationType

   Define the materials of a coaxial cable.

   :param core_material: The material of the core.

   :returns: The material specification of the dc cable.
   :rtype: DCCableMaterialSpecificationType


.. py:function:: calculate_dc_cable_heat_transfer(temperature_range_K: piel.types.physical.TemperatureRangeTypes = [273, 293], geometry_class: piel.types.electrical.cables.DCCableGeometryType = DCCableGeometryType(), material_class: piel.types.electrical.cables.DCCableMaterialSpecificationType | None = DCCableMaterialSpecificationType(), core_material: piel.types.materials.MaterialReferenceType = MaterialReferenceType()) -> piel.types.electrical.cables.DCCableHeatTransferType

   Calculate the heat transfer of a coaxial cable.

   :param temperature_range_K: The temperature range in Kelvin.
   :param geometry_class: The geometry of the cable.
   :param material_class: The material of the cable.
   :param core_material: The material of the core.

   :returns: The heat transfer of the cable.
   :rtype: DCCableHeatTransferType