pvlib-rust 0.1.6

A Rust port of pvlib-python: solar energy modeling toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

/// Surface albedo values for common surfaces.
#[inline]
pub fn surface_albedo(surface: &str) -> Option<f64> {
    match surface {
        "urban" => Some(0.18),
        "grass" => Some(0.20),
        "fresh grass" => Some(0.26),
        "soil" => Some(0.17),
        "sand" => Some(0.40),
        "snow" => Some(0.65),
        "fresh snow" => Some(0.75),
        "asphalt" => Some(0.12),
        "concrete" => Some(0.30),
        "aluminum" => Some(0.85),
        "copper" => Some(0.74),
        "fresh steel" => Some(0.35),
        "dirty steel" => Some(0.08),
        "sea" => Some(0.06),
        _ => None,
    }
}

/// Water color and roughness coefficients for the Dvoracek inland water albedo model.
fn water_coefficients(surface_condition: &str) -> Option<(f64, f64)> {
    match surface_condition {
        "clear_water_no_waves" => Some((0.13, 0.29)),
        "clear_water_ripples_up_to_2.5cm" => Some((0.16, 0.70)),
        "clear_water_ripples_larger_than_2.5cm_occasional_whitecaps" => Some((0.23, 1.25)),
        "clear_water_frequent_whitecaps" => Some((0.30, 2.0)),
        "green_water_ripples_up_to_2.5cm" => Some((0.22, 0.70)),
        "muddy_water_no_waves" => Some((0.19, 0.29)),
        _ => None,
    }
}

/// Estimation of albedo for inland water bodies using the Dvoracek model.
///
/// albedo = c^(r * sin(elevation) + 1)
///
/// Returns `f64::NAN` for an unrecognised `surface_condition`. Use
/// [`inland_water_dvoracek_try`] if you need to detect the unknown-condition
/// case explicitly.
///
/// # Arguments
/// * `solar_elevation` - Sun elevation angle in degrees.
/// * `surface_condition` - Water surface condition string. Known values:
///   `clear_water_no_waves`, `clear_water_ripples_up_to_2.5cm`,
///   `clear_water_ripples_larger_than_2.5cm_occasional_whitecaps`,
///   `clear_water_frequent_whitecaps`, `green_water_ripples_up_to_2.5cm`,
///   `muddy_water_no_waves`.
///
/// # Returns
/// Albedo value (dimensionless), or `f64::NAN` if `surface_condition` is unknown.
#[inline]
pub fn inland_water_dvoracek(solar_elevation: f64, surface_condition: &str) -> f64 {
    inland_water_dvoracek_try(solar_elevation, surface_condition).unwrap_or(f64::NAN)
}

/// Fallible variant of [`inland_water_dvoracek`] — returns `None` when the
/// `surface_condition` string is not one of the known Dvoracek categories,
/// instead of silently producing `NaN`.
#[inline]
pub fn inland_water_dvoracek_try(solar_elevation: f64, surface_condition: &str) -> Option<f64> {
    let (c, r) = water_coefficients(surface_condition)?;
    let elev = solar_elevation.max(0.0);
    Some(c.powf(r * elev.to_radians().sin() + 1.0))
}

/// Estimation of albedo for inland water bodies using custom coefficients.
///
/// albedo = color_coeff^(wave_roughness_coeff * sin(elevation) + 1)
///
/// # Arguments
/// * `solar_elevation` - Sun elevation angle in degrees.
/// * `color_coeff` - Water color coefficient.
/// * `wave_roughness_coeff` - Water wave roughness coefficient.
///
/// # Returns
/// Albedo value (dimensionless).
#[inline]
pub fn inland_water_dvoracek_custom(
    solar_elevation: f64,
    color_coeff: f64,
    wave_roughness_coeff: f64,
) -> f64 {
    let elev = solar_elevation.max(0.0);
    color_coeff.powf(wave_roughness_coeff * elev.to_radians().sin() + 1.0)
}