cffdrs 0.11.0

Rust implementation of the Canadian Forest Fire Danger Rating System
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
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
124
125
126
127
128
129
130
131
132

//! Helper functions for calculating FWI values from weather

use chrono::Datelike;

use crate::weather::Weather;

use super::{
    buildup_index, drought_code, duff_moisture_code, fire_weather_index,
    hourly_fine_fuel_moisture_code, initial_spread_index,
};

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Hourly values for the FWI system
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[derive(Debug, Clone)]
pub struct HourlyFwiValues {
    pub isi: f64,
    pub dc: f64,
    pub dmc: f64,
    pub ffmc: f64,
    pub bui: f64,
    pub fwi: f64,
}

impl HourlyFwiValues {
    pub fn as_starting_values(&self) -> StartingFwiValues {
        StartingFwiValues {
            dc: self.dc,
            dmc: self.dmc,
            ffmc: self.ffmc,
        }
    }
}

/// Represents the starting values for further FWI calculations. Usually observed from the previous
/// day. These are used for calculations that depend on their previous values
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[derive(Debug, Clone)]
pub struct StartingFwiValues {
    pub dc: f64,
    pub dmc: f64,
    pub ffmc: f64,
}

impl StartingFwiValues {
    const DEFAULT: StartingFwiValues = StartingFwiValues {
        ffmc: 50.,
        dmc: 50.,
        dc: 50.,
    };
}

/// Calculate all values for the FWI system from hourly weather
///
/// * `weather` - Hourly weather
/// * `previous` - FWI values from the previous hour. Providing this argument will improve the
///   accuracy of calculations
///
/// # Examples
///
/// ```
/// use cffdrs::fwi_system::calculate_hourly;
/// use cffdrs::weather::Weather;
/// use chrono::prelude::*;
///
/// let weather = Weather {
///     time: Utc.with_ymd_and_hms(2023, 7, 8, 9, 10, 11).unwrap(),
///     location: geo::Point::new(-120.34, 50.69),
///     temp: 28.,
///     rh: 12.,
///     ws: 16.,
///     wd: 95.,
///     precip: 0.,
/// };
///
/// let fwi_values = calculate_hourly(&weather, None);
///
/// assert_eq!(fwi_values.ffmc, 57.90482214144054);
/// assert_eq!(fwi_values.dmc, 56.014192448);
/// assert_eq!(fwi_values.dc, 58.744);
/// assert_eq!(fwi_values.isi, 0.7933315614248974);
/// assert_eq!(fwi_values.bui, 55.44718193037011);
/// assert_eq!(fwi_values.fwi, 2.2766000331952063);
/// ```
pub fn calculate_hourly(
    weather: &Weather,
    previous: Option<&StartingFwiValues>,
) -> HourlyFwiValues {
    let previous = previous.unwrap_or(&StartingFwiValues::DEFAULT);

    let ffmc = hourly_fine_fuel_moisture_code(
        weather.temp,
        weather.rh,
        weather.ws,
        weather.precip,
        previous.ffmc,
        Some(1.),
    );
    let dc = drought_code(
        previous.dc,
        weather.temp,
        weather.precip,
        weather.location.y(),
        weather.time.month() as usize,
        Some(true),
    );
    let dmc = duff_moisture_code(
        previous.dmc,
        weather.temp,
        weather.rh,
        weather.precip,
        weather.location.y(),
        weather.time.month() as usize,
        Some(true),
    );
    let bui = buildup_index(dmc, dc);
    let isi = initial_spread_index(ffmc, weather.ws);
    let fwi = fire_weather_index(isi, bui);

    HourlyFwiValues {
        ffmc,
        dmc,
        dc,
        isi,
        bui,
        fwi,
    }
}

// TODO: Add calculate_daily (and maybe calculate_diurnally?)