floccus 0.3.7

Formulae for air thermodynamic calculations
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

//!Functions to calculate dry bulb potential temperature of unsaturated air in K.

use crate::Float;
use crate::{
    constants::{C_P, R_D, ZERO_CELSIUS},
    errors::InputError,
};

#[cfg(feature="debug")]
use floccus_proc::logerr;

///Formula for computing wet bulb potential temperature from equivalent potential temperature.
///
///Derived by R. Davies-Jones (2008) [(doi:10.1175/2007MWR2224.1)](https://doi.org/10.1175/2007MWR2224.1)
///
///# Errors
///
///Returns [`InputError::OutOfRange`] when one of inputs is out of range.\
///Valid `temperature` range: 257K - 377K\
#[cfg_attr(feature = "debug", logerr)]
pub fn davies_jones1(equivalent_potential_temperature: Float) -> Result<Float, InputError> {
    if !(257.0..=377.0).contains(&equivalent_potential_temperature) {
        return Err(InputError::OutOfRange(String::from(
            "equivalent_potential_temperature",
        )));
    }

    let lambda = C_P / R_D;

    let result = 45.114 - 51.489 * (ZERO_CELSIUS / equivalent_potential_temperature).powf(lambda);
    Ok(result + ZERO_CELSIUS)
}

#[cfg(test)]
mod tests {
    use crate::{
        tests_framework::{self, Argument},
        wet_bulb_potential_temperature,
    };

    #[test]
    fn davies_jones1() {
        assert!(tests_framework::test_with_1arg(
            &wet_bulb_potential_temperature::davies_jones1,
            Argument {
                name: "equivalent_potential_temperature",
                def_val: 300.0,
                range: [257.0, 377.0]
            },
            281.17941447108467
        ));
    }
}