Skip to content

SolarHeating

SolarHeating 

SolarHeating(
    latitude: floatArrayLike,
    longitude: floatArrayLike,
    cable_azimuth: floatArrayLike,
    datetime_utc: datetimeArrayLike,
    outer_diameter: floatArrayLike,
    solar_absorptivity: floatArrayLike,
    albedo: floatArrayLike,
    nebulosity: floatArrayLike,
    measured_global_radiation: floatArrayLike,
    **kwargs: Any,
)

Bases: SolarHeatingBase

:param latitude: Latitude in degrees. :param longitude: Longitude in degrees (must be between -180 and +180 degrees). :param cable_azimuth: Azimuth of the conductor in degrees. :param datetime_utc: Datetime in UTC. :param outer_diameter: external diameter of the conductor. :param solar_absorptivity: Solar absorption coefficient of the conductor. :param albedo: Ground albedo. :param nebulosity: Sky nebulosity (0 to 8). :param measured_global_radiation: Optional measured global radiation (W/m2) used to compute solar irradiance.

Source code in src/thermohl/power/rte/solar_heating.py 
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
def __init__(
    self,
    latitude: floatArrayLike,
    longitude: floatArrayLike,
    cable_azimuth: floatArrayLike,
    datetime_utc: datetimeArrayLike,
    outer_diameter: floatArrayLike,
    solar_absorptivity: floatArrayLike,
    albedo: floatArrayLike,
    nebulosity: floatArrayLike,
    measured_global_radiation: floatArrayLike,
    **kwargs: Any,
):
    """Build with args.
    If more than one input are numpy arrays, they should have the same size.

    :param latitude: Latitude in degrees.
    :param longitude: Longitude in degrees (must be between -180 and +180 degrees).
    :param cable_azimuth: Azimuth of the conductor in degrees.
    :param datetime_utc: Datetime in UTC.
    :param outer_diameter: external diameter of the conductor.
    :param solar_absorptivity: Solar absorption coefficient of the conductor.
    :param albedo: Ground albedo.
    :param nebulosity: Sky nebulosity (0 to 8).
    :param measured_global_radiation: Optional measured global radiation (W/m2) used to compute solar irradiance.
    """
    if (
        kwargs.get("solar_irradiance", None) is not None
        and not np.isnan(kwargs["solar_irradiance"]).all()
    ):
        logger.warning(
            "Got 'solar_irradiance' keyword argument in SolarHeating.__init__, which is not supported by Rte "
            "implementation. This will be ignored."
        )
        kwargs.pop("solar_irradiance")

    date = datetime_utc.astype("datetime64[D]")
    solar_hour = sun.utc2solar_hour(datetime_utc, np.deg2rad(longitude))
    solar_altitude = sun.solar_altitude(np.deg2rad(latitude), date, solar_hour)
    nebulosity, global_radiation = compute_data_from_provided(
        measured_global_radiation, nebulosity, solar_altitude
    )
    solar_azimuth_rad = sun.solar_azimuth(np.deg2rad(latitude), date, solar_hour)
    incidence = compute_incidence(solar_altitude, solar_azimuth_rad, cable_azimuth)

    self.solar_absorptivity = solar_absorptivity
    self.outer_diameter = outer_diameter
    self.global_radiation = global_radiation
    self.solar_irradiance = compute_solar_irradiance(
        global_radiation,
        solar_altitude,
        incidence,
        nebulosity,
        albedo,
    )

derivative 

derivative(
    conductor_temperature: floatArrayLike,
) -> floatArrayLike

Compute solar heating derivative.

:param conductor_temperature: Conductor temperature. :return: Derivative of solar heating.

Source code in src/thermohl/power/solar_heating.py 
134
135
136
137
138
139
140
def derivative(self, conductor_temperature: floatArrayLike) -> floatArrayLike:
    """Compute solar heating derivative.

    :param conductor_temperature: Conductor temperature.
    :return: Derivative of solar heating.
    """
    return np.zeros_like(conductor_temperature)

value 

value(
    conductor_temperature: floatArrayLike,
) -> floatArrayLike

Compute solar heating.

:param conductor_temperature: Conductor temperature (°C). :return: Power term value (W·m⁻¹).

Source code in src/thermohl/power/solar_heating.py 
121
122
123
124
125
126
127
128
129
130
131
132
def value(self, conductor_temperature: floatArrayLike) -> floatArrayLike:
    """Compute solar heating.

    :param conductor_temperature: Conductor temperature (°C).
    :return: Power term value (W·m⁻¹).
    """
    return (
        self.solar_absorptivity
        * self.solar_irradiance
        * self.outer_diameter
        * np.ones_like(conductor_temperature)
    )

estimate_nebulosity 

estimate_nebulosity(
    diffuse_plus_beam_radiation: ndarray,
    datetime_utc: ndarray,
    latitude: ndarray,
    longitude: ndarray,
) -> np.array

Estimate nebulosity from measured diffuse radiation + beam radiation.

The results are rounded to the values which give the closest radiation sums.

Parameters:

Name Type Description Default

diffuse_plus_beam_solar_flow

ndarray

Array of diffuse radiation + beam radiation (in W/m²).

 required

datetime_utc

ndarray

Array of datetimes (more precisely np.datetime64). The year is indifferent.

 required

latitude

ndarray

Array of latitudes.

 required

longitude

ndarray

Array of longitudes.

 required

Returns: np.ndarray: Nebulosities (integers between 0 and 8, or nan if it can't be computed because of the night).

Source code in src/thermohl/power/rte/solar_heating.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def estimate_nebulosity(
    diffuse_plus_beam_radiation: np.ndarray,
    datetime_utc: np.ndarray,
    latitude: np.ndarray,
    longitude: np.ndarray,
) -> np.array:
    """Estimate nebulosity from measured diffuse radiation + beam radiation.

    The results are rounded to the values which give the closest radiation sums.

    Args:
        diffuse_plus_beam_solar_flow(np.ndarray): Array of diffuse radiation + beam radiation (in W/m²).
        datetime_utc(np.ndarray): Array of datetimes (more precisely np.datetime64). The year is indifferent.
        latitude(np.ndarray): Array of latitudes.
        longitude(np.ndarray): Array of longitudes.
    Returns:
        np.ndarray: Nebulosities (integers between 0 and 8, or nan if it can't be computed because of the night).
    """
    solar_hour = sun.utc2solar_hour(datetime_utc, np.deg2rad(longitude))
    solar_altitude = sun.solar_altitude(np.deg2rad(latitude), datetime_utc, solar_hour)
    return estimate_nebulosity_from_diffuse_and_beam_radiation(
        solar_altitude,
        diffuse_plus_beam_radiation,
    )

diffuse_and_beam_radiations 

diffuse_and_beam_radiations(
    datetime_utc: ndarray,
    latitude: ndarray,
    longitude: ndarray,
    nebulosity: ndarray,
) -> tuple[np.ndarray, np.ndarray]

Compute diffuse radiation and beam radiation.

Parameters:

Name Type Description Default

datetime_utc

ndarray

Array of datetimes (more precisely np.datetime64). The year is indifferent.

 required

latitude

ndarray

Array of latitudes.

 required

longitude

ndarray

Array of longitudes.

 required

nebulosity

ndarray

Array of nebulosities (integer between 0 and 8).

 required

Returns: tuple(np.ndarray, np.ndarray): diffuse_radiation, beam_radiation in W/m².

Source code in src/thermohl/power/rte/solar_heating.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def diffuse_and_beam_radiations(
    datetime_utc: np.ndarray,
    latitude: np.ndarray,
    longitude: np.ndarray,
    nebulosity: np.ndarray,
) -> tuple[np.ndarray, np.ndarray]:
    """Compute diffuse radiation and beam radiation.

    Args:
        datetime_utc(np.ndarray): Array of datetimes (more precisely np.datetime64). The year is indifferent.
        latitude(np.ndarray): Array of latitudes.
        longitude(np.ndarray): Array of longitudes.
        nebulosity(np.ndarray): Array of nebulosities (integer between 0 and 8).
    Returns:
        tuple(np.ndarray, np.ndarray): diffuse_radiation, beam_radiation in W/m².
    """
    if (nebulosity < 0).any() or (nebulosity > 8).any():
        raise ValueError(f"nebulosity must be between 0 and 8. Got {nebulosity}")

    solar_hour = sun.utc2solar_hour(datetime_utc, np.deg2rad(longitude))
    solar_altitude = sun.solar_altitude(np.deg2rad(latitude), datetime_utc, solar_hour)
    global_radiation = compute_global_radiation(solar_altitude, nebulosity)
    diffuse_radiation = compute_diffuse_radiation(global_radiation, nebulosity)
    beam_radiation = compute_beam_radiation(
        global_radiation, diffuse_radiation, solar_altitude
    )
    return diffuse_radiation, beam_radiation

solar_irradiance 

solar_irradiance(
    datetime_utc: NDArray[datetime64],
    latitude: ndarray,
    longitude: ndarray,
    nebulosity: ndarray,
    cable_azimuth: ndarray,
    albedo: ndarray | None = None,
) -> np.ndarray

Compute solar irradiance.

Wrapper around compute_solar_irradiance, it computes the same thing but from different inputs. It uses default albedo of 0.15.

Parameters:

Name Type Description Default

datetime_utc

NDArray[datetime64]

datetimes. Year is indifferent, feel free to set an arbitrary value.

 required

latitude

array

latitude.

 required

longitude

array

longitude.

 required

nebulosity

array

nebulosity (integers between 0 and 8).

 required

cable_azimuth

array

cable azimuth.

 required

albedo

array | None

albedo (describes how the ground reflects radiation). If not provided, a default value of 0.15 will be used.

 None

Returns:

Type Description
ndarray

Solar irradiance value.
Source code in src/thermohl/power/rte/solar_heating.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def solar_irradiance(
    datetime_utc: npt.NDArray[np.datetime64],
    latitude: np.ndarray,
    longitude: np.ndarray,
    nebulosity: np.ndarray,
    cable_azimuth: np.ndarray,
    albedo: np.ndarray | None = None,
) -> np.ndarray:
    """Compute solar irradiance.

    Wrapper around compute_solar_irradiance, it computes the same thing
    but from different inputs.
    It uses default albedo of 0.15.

    Args:
        datetime_utc(npt.NDArray[np.datetime64]): datetimes. Year is indifferent,
            feel free to set an arbitrary value.
        latitude(np.array): latitude.
        longitude(np.array): longitude.
        nebulosity(np.array): nebulosity (integers between 0 and 8).
        cable_azimuth(np.array): cable azimuth.
        albedo(np.array | None): albedo (describes how the ground reflects radiation).
            If not provided, a default value of 0.15 will be used.

    Returns:
        Solar irradiance value.
    """
    if albedo is None:
        albedo = np.full_like(latitude, 0.15, dtype=float)

    solar_hour = sun.utc2solar_hour(datetime_utc, np.deg2rad(longitude))
    solar_altitude = sun.solar_altitude(np.deg2rad(latitude), datetime_utc, solar_hour)
    global_radiation = compute_global_radiation(solar_altitude, nebulosity)
    solar_azimuth_rad = sun.solar_azimuth(
        np.deg2rad(latitude), datetime_utc, solar_hour
    )
    incidence = compute_incidence(solar_altitude, solar_azimuth_rad, cable_azimuth)
    return compute_solar_irradiance(  # type: ignore
        global_radiation,
        solar_altitude,
        incidence,
        nebulosity,
        albedo,
    )