gas-force 0.1.0

Typed ideal-gas state and reference-condition conversions
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
//! Typed ideal-gas state and reference-condition conversions.
//!
//! This crate applies `PV = nRT` to validated scalar quantities. Pressure is
//! always absolute and temperature is always stored in kelvin.

#![forbid(unsafe_code)]
#![warn(missing_docs)]

use std::error::Error;
use std::fmt;

/// Molar gas constant in joules per mole-kelvin.
pub const MOLAR_GAS_CONSTANT: f64 = 8.314_462_618_153_24;

/// A finite, positive absolute pressure stored in pascals.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct Pressure(f64);

impl Pressure {
    /// Creates an absolute pressure in pascals.
    pub fn pascals(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "absolute pressure")?;
        Ok(Self(value))
    }

    /// Creates an absolute pressure in kilopascals.
    pub fn kilopascals(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "absolute pressure")?;
        let pascals = value * 1_000.0;
        ensure_finite(pascals)?;
        Ok(Self(pascals))
    }

    /// Returns absolute pressure in pascals.
    pub const fn as_pascals(self) -> f64 {
        self.0
    }

    /// Returns absolute pressure in kilopascals.
    pub fn as_kilopascals(self) -> f64 {
        self.0 / 1_000.0
    }
}

/// A finite, positive volume stored in cubic meters.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct Volume(f64);

impl Volume {
    /// Creates a volume in cubic meters.
    pub fn cubic_meters(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "volume")?;
        Ok(Self(value))
    }

    /// Creates a volume in liters.
    pub fn liters(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "volume")?;
        Ok(Self(value / 1_000.0))
    }

    /// Returns volume in cubic meters.
    pub const fn as_cubic_meters(self) -> f64 {
        self.0
    }

    /// Returns volume in liters.
    pub fn as_liters(self) -> f64 {
        self.0 * 1_000.0
    }
}

/// A finite, positive absolute temperature stored in kelvin.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct Temperature(f64);

impl Temperature {
    /// Creates an absolute temperature in kelvin.
    pub fn kelvin(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "absolute temperature")?;
        Ok(Self(value))
    }

    /// Creates an absolute temperature from degrees Celsius.
    pub fn celsius(value: f64) -> Result<Self, GasError> {
        if !value.is_finite() {
            return Err(GasError::NonFinite("temperature"));
        }
        let kelvin = value + 273.15;
        validate_positive_finite(kelvin, "absolute temperature")?;
        Ok(Self(kelvin))
    }

    /// Returns absolute temperature in kelvin.
    pub const fn as_kelvin(self) -> f64 {
        self.0
    }

    /// Returns temperature in degrees Celsius.
    pub fn as_celsius(self) -> f64 {
        self.0 - 273.15
    }
}

/// A finite, positive amount of substance stored in moles.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct Amount(f64);

impl Amount {
    /// Creates an amount of substance in moles.
    pub fn moles(value: f64) -> Result<Self, GasError> {
        validate_positive_finite(value, "amount")?;
        Ok(Self(value))
    }

    /// Returns amount of substance in moles.
    pub const fn as_moles(self) -> f64 {
        self.0
    }
}

/// A finite, non-negative volumetric flow stored in cubic meters per second.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct VolumetricFlow(f64);

impl VolumetricFlow {
    /// Creates a volumetric flow in cubic meters per second.
    pub fn cubic_meters_per_second(value: f64) -> Result<Self, GasError> {
        validate_non_negative_finite(value, "volumetric flow")?;
        Ok(Self(value))
    }

    /// Returns volumetric flow in cubic meters per second.
    pub const fn as_cubic_meters_per_second(self) -> f64 {
        self.0
    }
}

/// Pressure and temperature defining a gas reference condition.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct GasCondition {
    pressure: Pressure,
    temperature: Temperature,
}

impl GasCondition {
    /// Creates a reference condition from absolute pressure and temperature.
    pub const fn new(pressure: Pressure, temperature: Temperature) -> Self {
        Self {
            pressure,
            temperature,
        }
    }

    /// Returns absolute pressure.
    pub const fn pressure(self) -> Pressure {
        self.pressure
    }

    /// Returns absolute temperature.
    pub const fn temperature(self) -> Temperature {
        self.temperature
    }
}

/// A complete equilibrium state satisfying the ideal gas equation.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct IdealGasState {
    pressure: Pressure,
    volume: Volume,
    temperature: Temperature,
    amount: Amount,
}

impl IdealGasState {
    /// Derives amount from pressure, volume, and temperature.
    pub fn from_pressure_volume_temperature(
        pressure: Pressure,
        volume: Volume,
        temperature: Temperature,
    ) -> Result<Self, GasError> {
        let amount = Amount(checked(
            pressure.0 * volume.0 / (MOLAR_GAS_CONSTANT * temperature.0),
        )?);
        Ok(Self {
            pressure,
            volume,
            temperature,
            amount,
        })
    }

    /// Derives pressure from amount, volume, and temperature.
    pub fn from_amount_volume_temperature(
        amount: Amount,
        volume: Volume,
        temperature: Temperature,
    ) -> Result<Self, GasError> {
        let pressure = Pressure(checked(
            amount.0 * MOLAR_GAS_CONSTANT * temperature.0 / volume.0,
        )?);
        Ok(Self {
            pressure,
            volume,
            temperature,
            amount,
        })
    }

    /// Derives volume from pressure, amount, and temperature.
    pub fn from_pressure_amount_temperature(
        pressure: Pressure,
        amount: Amount,
        temperature: Temperature,
    ) -> Result<Self, GasError> {
        let volume = Volume(checked(
            amount.0 * MOLAR_GAS_CONSTANT * temperature.0 / pressure.0,
        )?);
        Ok(Self {
            pressure,
            volume,
            temperature,
            amount,
        })
    }

    /// Derives temperature from pressure, volume, and amount.
    pub fn from_pressure_volume_amount(
        pressure: Pressure,
        volume: Volume,
        amount: Amount,
    ) -> Result<Self, GasError> {
        let temperature = Temperature(checked(
            pressure.0 * volume.0 / (amount.0 * MOLAR_GAS_CONSTANT),
        )?);
        Ok(Self {
            pressure,
            volume,
            temperature,
            amount,
        })
    }

    /// Returns absolute pressure.
    pub const fn pressure(self) -> Pressure {
        self.pressure
    }

    /// Returns volume.
    pub const fn volume(self) -> Volume {
        self.volume
    }

    /// Returns absolute temperature.
    pub const fn temperature(self) -> Temperature {
        self.temperature
    }

    /// Returns amount of substance.
    pub const fn amount(self) -> Amount {
        self.amount
    }
}

/// Converts an ideal-gas volume between pressure and temperature conditions.
pub fn convert_volume(
    volume: Volume,
    from: GasCondition,
    to: GasCondition,
) -> Result<Volume, GasError> {
    let converted =
        volume.0 * from.pressure.0 / to.pressure.0 * to.temperature.0 / from.temperature.0;
    Ok(Volume(checked(converted)?))
}

/// Converts ideal-gas volumetric flow between pressure and temperature conditions.
pub fn convert_flow(
    flow: VolumetricFlow,
    from: GasCondition,
    to: GasCondition,
) -> Result<VolumetricFlow, GasError> {
    let converted =
        flow.0 * from.pressure.0 / to.pressure.0 * to.temperature.0 / from.temperature.0;
    ensure_finite(converted)?;
    Ok(VolumetricFlow(converted))
}

/// Invalid quantity or a result outside finite positive numeric range.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum GasError {
    /// A named input was not finite.
    NonFinite(&'static str),
    /// A named input was negative.
    Negative(&'static str),
    /// A named input had to be positive but was zero.
    Zero(&'static str),
    /// Arithmetic produced a non-finite or non-positive derived state.
    CalculationOutOfRange,
}

impl fmt::Display for GasError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::NonFinite(name) => write!(formatter, "{name} must be finite"),
            Self::Negative(name) => write!(formatter, "{name} must not be negative"),
            Self::Zero(name) => write!(formatter, "{name} must be greater than zero"),
            Self::CalculationOutOfRange => {
                formatter.write_str("calculation produced an out-of-range result")
            }
        }
    }
}

impl Error for GasError {}

fn validate_non_negative_finite(value: f64, name: &'static str) -> Result<(), GasError> {
    if !value.is_finite() {
        return Err(GasError::NonFinite(name));
    }
    if value < 0.0 {
        return Err(GasError::Negative(name));
    }
    Ok(())
}

fn validate_positive_finite(value: f64, name: &'static str) -> Result<(), GasError> {
    validate_non_negative_finite(value, name)?;
    if value == 0.0 {
        return Err(GasError::Zero(name));
    }
    Ok(())
}

fn ensure_finite(value: f64) -> Result<(), GasError> {
    if value.is_finite() {
        Ok(())
    } else {
        Err(GasError::CalculationOutOfRange)
    }
}

fn checked(value: f64) -> Result<f64, GasError> {
    if value.is_finite() && value > 0.0 {
        Ok(value)
    } else {
        Err(GasError::CalculationOutOfRange)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn pressure(value: f64) -> Pressure {
        Pressure::pascals(value).unwrap()
    }

    fn volume(value: f64) -> Volume {
        Volume::cubic_meters(value).unwrap()
    }

    fn temperature(value: f64) -> Temperature {
        Temperature::kelvin(value).unwrap()
    }

    #[test]
    fn derives_each_ideal_gas_variable() {
        let p = pressure(100_000.0);
        let t = temperature(300.0);
        let n = Amount::moles(1.0).unwrap();
        let v = volume(MOLAR_GAS_CONSTANT * 300.0 / 100_000.0);

        let by_amount = IdealGasState::from_pressure_volume_temperature(p, v, t).unwrap();
        let by_pressure = IdealGasState::from_amount_volume_temperature(n, v, t).unwrap();
        let by_volume = IdealGasState::from_pressure_amount_temperature(p, n, t).unwrap();
        let by_temperature = IdealGasState::from_pressure_volume_amount(p, v, n).unwrap();

        assert!((by_amount.amount().0 - 1.0).abs() < 1e-12);
        assert!((by_pressure.pressure().0 - p.0).abs() < 1e-9);
        assert!((by_volume.volume().0 - v.0).abs() < 1e-15);
        assert!((by_temperature.temperature().0 - t.0).abs() < 1e-12);
    }

    #[test]
    fn pressure_conversion_is_explicit() {
        let pressure = Pressure::kilopascals(101.325).unwrap();
        assert!((pressure.as_pascals() - 101_325.0).abs() < 1e-10);
        assert_eq!(pressure.as_kilopascals(), 101.325);
    }

    #[test]
    fn celsius_is_stored_as_kelvin() {
        let temperature = Temperature::celsius(26.85).unwrap();
        assert!((temperature.as_kelvin() - 300.0).abs() < 1e-12);
        assert!((temperature.as_celsius() - 26.85).abs() < 1e-12);
    }

    #[test]
    fn pressure_change_converts_volume() {
        let from = GasCondition::new(pressure(100_000.0), temperature(300.0));
        let to = GasCondition::new(pressure(200_000.0), temperature(300.0));
        let converted = convert_volume(volume(1.0), from, to).unwrap();
        assert!((converted.0 - 0.5).abs() < 1e-12);
    }

    #[test]
    fn temperature_change_converts_flow() {
        let from = GasCondition::new(pressure(100_000.0), temperature(300.0));
        let to = GasCondition::new(pressure(100_000.0), temperature(600.0));
        let flow = VolumetricFlow::cubic_meters_per_second(0.25).unwrap();
        let converted = convert_flow(flow, from, to).unwrap();
        assert!((converted.0 - 0.5).abs() < 1e-12);
    }

    #[test]
    fn zero_flow_remains_zero() {
        let condition = GasCondition::new(pressure(100_000.0), temperature(300.0));
        let flow = VolumetricFlow::cubic_meters_per_second(0.0).unwrap();
        assert_eq!(convert_flow(flow, condition, condition).unwrap().0, 0.0);
    }

    #[test]
    fn invalid_quantities_are_rejected() {
        assert_eq!(
            Pressure::pascals(0.0),
            Err(GasError::Zero("absolute pressure"))
        );
        assert_eq!(Volume::liters(-1.0), Err(GasError::Negative("volume")));
        assert_eq!(
            Temperature::kelvin(f64::NAN),
            Err(GasError::NonFinite("absolute temperature"))
        );
        assert_eq!(
            Temperature::celsius(-273.15),
            Err(GasError::Zero("absolute temperature"))
        );
        assert_eq!(Amount::moles(0.0), Err(GasError::Zero("amount")));
    }

    #[test]
    fn calculation_overflow_is_reported() {
        let result = IdealGasState::from_amount_volume_temperature(
            Amount::moles(f64::MAX).unwrap(),
            volume(f64::MIN_POSITIVE),
            temperature(300.0),
        );
        assert_eq!(result, Err(GasError::CalculationOutOfRange));
    }
}