rfluids 0.3.1

🦀 Rusty CoolProp wrapper
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

//! Thermophysical properties of _**real**_ humid air.
//!
//! This module provides a comprehensive interface for calculating thermophysical properties of
//! _**real**_ humid air through the [`HumidAir`] struct.
//!
//! Properties are calculated in accordance with **ASHRAE RP-1485**.

mod common;
mod defined;
mod invariant;
mod request;
mod undefined;

use std::{collections::HashMap, marker::PhantomData};

use request::HumidAirUpdateRequest;

use crate::{
    io::HumidAirParam,
    native::CoolPropError,
    state_variant::{Defined, StateVariant},
};

/// Result type for operations that could fail while updating humid air state.
pub type StateResult<T> = Result<T, HumidAirStateError>;

/// Result type for operations that could fail while retrieving humid air properties.
pub type OutputResult<T> = Result<T, HumidAirOutputError>;

/// Provider of thermophysical properties of _**real**_ humid air.
///
/// It implements the [Typestate Pattern](https://en.wikipedia.org/wiki/Typestate_analysis)
/// and has one generic type parameter: `S` -- state variant
/// _([`Defined`] or [`Undefined`](crate::state_variant::Undefined))_.
///
/// Depending on `S`, the `HumidAir` instance has different functionality.
///
/// Properties are calculated in accordance with **ASHRAE RP-1485**.
///
/// # See Also
///
/// - [Humid Air Properties](https://coolprop.org/fluid_properties/HumidAir.html)
#[derive(Debug)]
pub struct HumidAir<S: StateVariant = Defined> {
    update_request: Option<HumidAirUpdateRequest>,
    outputs: HashMap<HumidAirParam, OutputResult<f64>>,
    state: PhantomData<S>,
}

/// Error during [`HumidAir::update`] or [`HumidAir::in_state`].
#[derive(Clone, Debug, Eq, PartialEq, thiserror::Error)]
pub enum HumidAirStateError {
    /// Specified inputs are invalid.
    #[error("Specified inputs (`{0:?}`, `{1:?}`, `{2:?}`) are invalid!")]
    InvalidInputs(HumidAirParam, HumidAirParam, HumidAirParam),

    /// Some of the specified input value is infinite or NaN.
    #[error("Input values must be finite!")]
    InvalidInputValue,
}

/// Error during calculation of the [`HumidAir`] output parameter value.
#[derive(Clone, Debug, Eq, PartialEq, thiserror::Error)]
pub enum HumidAirOutputError {
    /// Specified output parameter is not available.
    #[error("Specified output parameter `{0:?}` is not available!")]
    UnavailableOutput(HumidAirParam),

    /// Failed to calculate the output parameter value.
    #[error("Failed to calculate the output value of `{0:?}`! {1}")]
    CalculationFailed(HumidAirParam, CoolPropError),
}