feos 0.9.5

FeOs - A framework for equations of state and classical density functional theory.
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
#![allow(clippy::excessive_precision)]
use super::TemperatureDependentProperties;
use crate::saftvrqmie::parameters::SaftVRQMiePars;
use feos_core::StateHD;
use nalgebra::DVector;
use num_dual::DualNum;
use std::f64::consts::TAU;
use std::fmt;

/// Boltzmann's constant in J/K
const KB: f64 = 1.380649e-23;
const PLANCK: f64 = 6.62607015e-34;
const D_QM_PREFACTOR: f64 = PLANCK * PLANCK / (TAU * TAU) / 12.0 * 1e20 / KB;

const X_K21: [f64; 21] = [
    -0.995657163025808080735527280689003,
    -0.973906528517171720077964012084452,
    -0.930157491355708226001207180059508,
    -0.865063366688984510732096688423493,
    -0.780817726586416897063717578345042,
    -0.679409568299024406234327365114874,
    -0.562757134668604683339000099272694,
    -0.433395394129247190799265943165784,
    -0.294392862701460198131126603103866,
    -0.148874338981631210884826001129720,
    0.000000000000000000000000000000000,
    0.148874338981631210884826001129720,
    0.294392862701460198131126603103866,
    0.433395394129247190799265943165784,
    0.562757134668604683339000099272694,
    0.679409568299024406234327365114874,
    0.780817726586416897063717578345042,
    0.865063366688984510732096688423493,
    0.930157491355708226001207180059508,
    0.973906528517171720077964012084452,
    0.995657163025808080735527280689003,
];

const W_K21: [f64; 21] = [
    0.011694638867371874278064396062192,
    0.032558162307964727478818972459390,
    0.054755896574351996031381300244580,
    0.075039674810919952767043140916190,
    0.093125454583697605535065465083366,
    0.109387158802297641899210590325805,
    0.123491976262065851077958109831074,
    0.134709217311473325928054001771707,
    0.142775938577060080797094273138717,
    0.147739104901338491374841515972068,
    0.149445554002916905664936468389821,
    0.147739104901338491374841515972068,
    0.142775938577060080797094273138717,
    0.134709217311473325928054001771707,
    0.123491976262065851077958109831074,
    0.109387158802297641899210590325805,
    0.093125454583697605535065465083366,
    0.075039674810919952767043140916190,
    0.054755896574351996031381300244580,
    0.032558162307964727478818972459390,
    0.011694638867371874278064396062192,
];

impl SaftVRQMiePars {
    #[inline]
    pub fn hs_diameter<D: DualNum<f64> + Copy>(&self, temperature: D) -> DVector<D> {
        DVector::from_fn(self.m.len(), |i, _| -> D {
            let sigma_eff = self.calc_sigma_eff_ij(i, i, temperature);
            self.hs_diameter_ij(i, i, temperature, sigma_eff)
        })
    }

    #[inline]
    pub fn hs_diameter_ij<D: DualNum<f64> + Copy>(
        &self,
        i: usize,
        j: usize,
        temperature: D,
        sigma_eff: D,
    ) -> D {
        let r0 = self.zero_integrand(i, j, temperature, sigma_eff);
        let mut d_hs = r0;
        for k in 0..21 {
            let width = (sigma_eff - r0) * 0.5;
            let r = width * X_K21[k] + width + r0;
            let u = self.qmie_potential_ij(i, j, r, temperature);
            let f_u = -(-u[0] / temperature).exp() + 1.0;
            d_hs += width * f_u * W_K21[k];
        }
        d_hs
    }

    pub fn zero_integrand<D: DualNum<f64> + Copy>(
        &self,
        i: usize,
        j: usize,
        temperature: D,
        sigma_eff: D,
    ) -> D {
        let mut r = sigma_eff * 0.7;
        let mut f = D::zero();
        for _k in 1..20 {
            let u_vec = self.qmie_potential_ij(i, j, r, temperature);
            f = u_vec[0] / temperature + f64::EPSILON.ln();
            if f.re().abs() < 1.0e-12 {
                break;
            }
            let dfdr = u_vec[1] / temperature;
            let mut dr = -(f / dfdr);
            if dr.re().abs() > 0.5 {
                dr *= 0.5 / dr.re().abs();
            }
            r += dr;
        }
        if f.re().abs() > 1.0e-12 {
            println!("zero_integrand calculation failed {}", f.re().abs());
        }
        r
    }

    #[inline]
    pub fn epsilon_k_eff<D: DualNum<f64> + Copy>(&self, temperature: D) -> DVector<D> {
        DVector::from_fn(self.m.len(), |i, _| -> D {
            self.calc_epsilon_k_eff_ij(i, i, temperature)
        })
    }

    pub fn calc_epsilon_k_eff_ij<D: DualNum<f64> + Copy>(
        &self,
        i: usize,
        j: usize,
        temperature: D,
    ) -> D {
        let mut r = D::one() * self.sigma_ij[(i, j)];
        let mut u_vec = [D::zero(), D::zero(), D::zero()];
        for _k in 1..20 {
            u_vec = self.qmie_potential_ij(i, j, r, temperature);
            if u_vec[1].re().abs() < 1.0e-12 {
                break;
            }
            r += -u_vec[1] / u_vec[2];
        }
        if u_vec[1].re().abs() > 1.0e-12 {
            println!("calc_epsilon_k_eff_ij calculation failed");
        }
        -u_vec[0]
    }

    #[inline]
    pub fn sigma_eff<D: DualNum<f64> + Copy>(&self, temperature: D) -> DVector<D> {
        DVector::from_fn(self.m.len(), |i, _| -> D {
            self.calc_sigma_eff_ij(i, i, temperature)
        })
    }

    pub fn calc_sigma_eff_ij<D: DualNum<f64> + Copy>(
        &self,
        i: usize,
        j: usize,
        temperature: D,
    ) -> D {
        let mut r = D::one() * self.sigma_ij[(i, j)];
        let mut u_vec = [D::zero(), D::zero(), D::zero()];
        for _k in 1..20 {
            u_vec = self.qmie_potential_ij(i, j, r, temperature);
            if u_vec[0].re().abs() < 1.0e-12 {
                break;
            }
            r += -u_vec[0] / u_vec[1];
        }
        if u_vec[0].re().abs() > 1.0e-12 {
            println!("calc_sigma_eff_ij calculation failed");
        }
        r
    }

    #[inline]
    pub fn quantum_d_ij<D: DualNum<f64>>(&self, i: usize, j: usize, temperature: D) -> D {
        quantum_d_mass(self.mass_ij[(i, j)], temperature)
    }

    /// Feynman-Hibbs corrected potential
    pub fn qmie_potential_ij<D: DualNum<f64> + Copy>(
        &self,
        i: usize,
        j: usize,
        r: D,
        temperature: D,
    ) -> [D; 3] {
        let lr = self.lambda_r_ij[(i, j)];
        let la = self.lambda_a_ij[(i, j)];
        let s = self.sigma_ij[(i, j)];
        let eps = self.epsilon_k_ij[(i, j)];
        let c = self.c_ij[(i, j)];

        let q1r = lr * (lr - 1.0);
        let q1a = la * (la - 1.0);
        let q2r = 0.5 * (lr + 2.0) * (lr + 1.0) * lr * (lr - 1.0);
        let q2a = 0.5 * (la + 2.0) * (la + 1.0) * la * (la - 1.0);
        let d = self.quantum_d_ij(i, j, temperature);
        let mut u = r.powf(lr).recip() * s.powf(lr) - r.powf(la).recip() * s.powf(la);
        let mut u_r = -r.powf(lr + 1.0).recip() * lr * s.powf(lr)
            + r.powf(la + 1.0).recip() * la * s.powf(la);
        let mut u_rr = r.powf(lr + 2.0).recip() * lr * (lr + 1.0) * s.powf(lr)
            - r.powf(la + 2.0).recip() * la * (la + 1.0) * s.powf(la);
        if self.fh_ij[(i, j)] as usize > 0 {
            u += d
                * (r.powf(lr + 2.0).recip() * q1r * s.powf(lr)
                    - r.powf(la + 2.0).recip() * q1a * s.powf(la));
            u_r += d
                * (r.powf(lr + 3.0).recip() * -q1r * (lr + 2.0) * s.powf(lr)
                    + r.powf(la + 3.0).recip() * q1a * (la + 2.0) * s.powf(la));
            u_rr += d
                * (r.powf(lr + 4.0).recip() * q1r * (lr + 2.0) * (lr + 3.0) * s.powf(lr)
                    - r.powf(la + 4.0).recip() * q1a * (la + 2.0) * (la + 3.0) * s.powf(la));
        }
        if self.fh_ij[(i, j)] as usize > 1 {
            u += d.powi(2)
                * (r.powf(lr + 4.0).recip() * q2r * s.powf(lr)
                    - r.powf(la + 4.0).recip() * q2a * s.powf(la));
            u_r += d.powi(2)
                * (-r.powf(lr + 5.0).recip() * q2r * (lr + 4.0) * s.powf(lr)
                    + r.powf(la + 5.0).recip() * q2a * (la + 4.0) * s.powf(la));
            u_rr += d.powi(2)
                * (r.powf(lr + 6.0).recip() * q2r * (lr + 4.0) * (lr + 5.0) * s.powf(lr)
                    - r.powf(la + 6.0).recip() * q2a * (la + 4.0) * (la + 5.0) * s.powf(la));
        }
        u *= c * eps;
        u_r *= c * eps;
        u_rr *= c * eps;
        [u, u_r, u_rr]
    }
}

#[inline]
pub fn quantum_d_mass<D: DualNum<f64>>(mass: f64, temperature: D) -> D {
    temperature.recip() / mass * D_QM_PREFACTOR
}

pub struct HardSphere;

impl HardSphere {
    pub fn helmholtz_energy_density<D: DualNum<f64> + Copy>(
        &self,
        parameters: &SaftVRQMiePars,
        state: &StateHD<D>,
        properties: &TemperatureDependentProperties<D>,
    ) -> D {
        let d = DVector::from_fn(parameters.m.len(), |i, _| properties.hs_diameter_ij[(i, i)]);
        let zeta = zeta(&parameters.m, &state.partial_density, &d);
        let frac_1mz3 = -(zeta[3] - 1.0).recip();
        let zeta_23 = zeta_23(&parameters.m, &state.molefracs, &d);
        (zeta[1] * zeta[2] * frac_1mz3 * 3.0
            + zeta[2].powi(2) * frac_1mz3.powi(2) * zeta_23
            + (zeta[2] * zeta_23.powi(2) - zeta[0]) * (zeta[3] * (-1.0)).ln_1p())
            * 6.0
            / std::f64::consts::PI
    }
}

impl fmt::Display for HardSphere {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Hard Sphere")
    }
}

pub fn zeta<D: DualNum<f64> + Copy>(
    m: &DVector<f64>,
    partial_density: &DVector<D>,
    diameter: &DVector<D>,
) -> [D; 4] {
    let mut zeta: [D; 4] = [D::zero(), D::zero(), D::zero(), D::zero()];
    for i in 0..m.len() {
        for (k, z) in zeta.iter_mut().enumerate() {
            *z += partial_density[i]
                * diameter[i].powi(k as i32)
                * (std::f64::consts::PI / 6.0 * m[i]);
        }
    }
    zeta
}

pub fn zeta_23<D: DualNum<f64> + Copy>(
    m: &DVector<f64>,
    molefracs: &DVector<D>,
    diameter: &DVector<D>,
) -> D {
    let mut zeta: [D; 2] = [D::zero(), D::zero()];
    for i in 0..m.len() {
        for (k, z) in zeta.iter_mut().enumerate() {
            *z += molefracs[i] * diameter[i].powi((k + 2) as i32) * m[i];
        }
    }
    zeta[0] / zeta[1]
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::saftvrqmie::parameters::utils::h2_ne_fh;
    use crate::saftvrqmie::parameters::utils::hydrogen_fh;
    use approx::assert_relative_eq;
    use nalgebra::dvector;
    use num_dual::Dual64;

    #[test]
    fn test_quantum_d_mass() {
        let parameters = hydrogen_fh("1");
        let temperature = 26.7060;
        let r = 3.5;
        let u0 = parameters.qmie_potential_ij(0, 0, r, temperature);
        let eps = 1.0e-5;
        let u2 = parameters.qmie_potential_ij(0, 0, r + eps, temperature);
        let u1 = parameters.qmie_potential_ij(0, 0, r - eps, temperature);
        let dudr_num = (u2[0] - u1[0]) / eps / 2.0;
        let d2udr2_num = (u2[1] - u1[1]) / eps / 2.0;
        assert!(((dudr_num - u0[1]) / u0[1]).abs() < 1.0e-9);
        assert!(((d2udr2_num - u0[2]) / u0[2]).abs() < 1.0e-9);
    }

    #[test]
    fn test_sigma_effective() {
        let parameters = hydrogen_fh("1");
        let temperature = 26.7060;
        let sigma_eff = parameters.calc_sigma_eff_ij(0, 0, temperature);
        println!("{}", sigma_eff - 3.2540054024660556);
        assert!((sigma_eff - 3.2540054024660556).abs() < 5.0e-7)
    }

    #[test]
    fn test_eps_div_k_effective() {
        let parameters = hydrogen_fh("1");
        let temperature = 26.7060;
        let epsilon_k_eff = parameters.calc_epsilon_k_eff_ij(0, 0, temperature);
        println!("{}", epsilon_k_eff - 21.654396207986697);
        assert!((epsilon_k_eff - 21.654396207986697).abs() < 1.0e-6)
    }

    #[test]
    fn test_zero_integrand() {
        let parameters = hydrogen_fh("1");
        let temperature = 26.706;
        let sigma_eff = parameters.calc_sigma_eff_ij(0, 0, temperature);
        let r0 = parameters.zero_integrand(0, 0, temperature, sigma_eff);
        println!("{}", r0 - 2.5265031901173732);
        assert!((r0 - 2.5265031901173732).abs() < 5.0e-7)
    }

    #[test]
    fn test_hs_diameter() {
        let parameters = hydrogen_fh("1");
        let temperature = Dual64::from(26.7060).derivative();
        let sigma_eff = parameters.calc_sigma_eff_ij(0, 0, temperature);
        let d_hs = parameters.hs_diameter_ij(0, 0, temperature, sigma_eff);
        assert!((d_hs.re - 3.1410453883283341).abs() < 5.0e-8);
        assert!((d_hs.eps + 8.4528823966252661e-3).abs() < 1.0e-9);
    }

    #[test]
    fn test_hs_helmholtz_energy() {
        let parameters = hydrogen_fh("1");
        let na = 6.02214076e23;
        let t = 26.7060;
        let v = 1.0e26;
        let n = na * 1.1;
        let s = StateHD::new(t, v / n, &dvector![1.0]);
        let properties = TemperatureDependentProperties::new(&parameters, s.temperature);
        let a_rust = HardSphere.helmholtz_energy_density(&parameters, &s, &properties) * v;
        dbg!(a_rust / na);
        assert_relative_eq!(a_rust / na, 0.54586730268029837, epsilon = 5e-7);
    }

    #[test]
    fn test_hs_helmholtz_energy_fh2() {
        let parameters = hydrogen_fh("2");
        let na = 6.02214076e23;
        let t = 26.7060;
        let v = 1.0e26;
        let n = na * 1.1;
        let s = StateHD::new(t, v / n, &dvector![1.0]);
        let properties = TemperatureDependentProperties::new(&parameters, s.temperature);
        let a_rust = HardSphere.helmholtz_energy_density(&parameters, &s, &properties) * v;
        dbg!(a_rust / na);
        assert_relative_eq!(a_rust / na, 0.5934447545083482, epsilon = 5e-7);
    }

    #[test]
    fn test_hs_helmholtz_energy_mix() {
        let parameters = h2_ne_fh("1");
        let na = 6.02214076e23;
        let t = 30.0;
        let v = 1.0e26;
        let n = dvector![na * 1.1, na * 1.0];
        let s = StateHD::new(t, v / n.sum(), &(&n / n.sum()));
        let properties = TemperatureDependentProperties::new(&parameters, s.temperature);
        let a_rust = HardSphere.helmholtz_energy_density(&parameters, &s, &properties) * v;
        dbg!(a_rust / na);
        // non-additive: 1.8249307925054206
        assert_relative_eq!(a_rust / na, 1.8074833133403905, epsilon = 5e-7);
    }

    #[test]
    fn test_hs_helmholtz_energy_mix_fh2() {
        let parameters = h2_ne_fh("2");
        let na = 6.02214076e23;
        let t = 30.0;
        let v = 1.0e26;
        let n = dvector![na * 1.1, na * 1.0];
        let s = StateHD::new(t, v / n.sum(), &(&n / n.sum()));
        let properties = TemperatureDependentProperties::new(&parameters, s.temperature);
        let a_rust = HardSphere.helmholtz_energy_density(&parameters, &s, &properties) * v;
        dbg!(a_rust / na);
        assert_relative_eq!(a_rust / na, 1.898534632022848, epsilon = 5e-7);
    }
}