Skip to content

PowerTerm

PowerTerm 

PowerTerm(**kwargs: Any)

Bases: ABC

Base class for power term.

Source code in src/thermohl/power/power_term.py 
21
22
def __init__(self, **kwargs: Any):
    pass

derivative 

derivative(
    conductor_temperature: floatArrayLike,
    temperature_increment: float = _TEMP_INCREMENT,
) -> floatArrayLike

Compute power term derivative regarding temperature in function of temperature.

Usually this function should be overriden in children classes; if it is not the case it will evaluate the derivative from the value method with a second-order approximation.

Parameters:

Name Type Description Default

conductor_temperature

float | ndarray

Conductor temperature (°C).

 required

temperature_increment

float

Temperature increment. The default is 1.0E-03.

 _TEMP_INCREMENT

Returns:

Type Description
floatArrayLike

float | numpy.ndarray: Power term derivative (W·m⁻¹·K⁻¹).
Source code in src/thermohl/power/power_term.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def derivative(
    self,
    conductor_temperature: floatArrayLike,
    temperature_increment: float = _TEMP_INCREMENT,
) -> floatArrayLike:
    r"""Compute power term derivative regarding temperature in function of temperature.

    Usually this function should be overriden in children classes; if it is
    not the case it will evaluate the derivative from the value method with
    a second-order approximation.

    Args:
        conductor_temperature (float | numpy.ndarray): Conductor temperature (°C).
        temperature_increment (float, optional): Temperature increment. The default is 1.0E-03.

    Returns:
        float | numpy.ndarray: Power term derivative (W·m⁻¹·K⁻¹).

    """
    return (
        self.value(conductor_temperature + temperature_increment)
        - self.value(conductor_temperature - temperature_increment)
    ) / (2.0 * temperature_increment)

value 

value(
    conductor_temperature: floatArrayLike,
) -> floatArrayLike

Compute power term value in function of temperature.

Usually this function should be overridden in children classes; if it is not the case it will just return zero.

Parameters:

Name Type Description Default

conductor_temperature

float | ndarray

Conductor temperature (°C).

 required

Returns:

Type Description
floatArrayLike

float | numpy.ndarray: Power term value (W·m⁻¹).
Source code in src/thermohl/power/power_term.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def value(self, conductor_temperature: floatArrayLike) -> floatArrayLike:
    r"""Compute power term value in function of temperature.

    Usually this function should be overridden in children classes; if it is
    not the case it will just return zero.

    Args:
        conductor_temperature (float | numpy.ndarray): Conductor temperature (°C).

    Returns:
        float | numpy.ndarray: Power term value (W·m⁻¹).

    """
    return (
        np.zeros_like(conductor_temperature)
        if not np.isscalar(conductor_temperature)
        else 0.0
    )