xcx 0.2.0

Exchange–correlation functionals for density-functional theory (DFT) — pure-Rust, libxc-compatible
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! Concrete functional registry.
//!
//! The public contract (types + metadata, see `docs/api-convention.md`) is
//! frozen before any functional math is written. Functionals land in subsequent
//! steps; each file will be tagged with its provenance
//! (`Provenance: ported-from-libxc` / `Provenance: clean-room`).

use crate::error::XcError;
use crate::families::XcEval;
use crate::func::FunctionalId;

mod gga_c_lyp;
mod gga_c_pbe;
mod gga_c_pbe_sol;
mod gga_x_b88;
mod gga_x_pbe;
mod gga_x_pbe_r;
mod gga_x_pbe_sol;
mod gga_x_rpbe;
mod hybrids;
mod lda_c_pw;
mod lda_c_vwn;
mod lda_c_vwn_3;
mod lda_c_vwn_rpa;
mod lda_x;
mod mgga_c_m06_l;
mod mgga_c_r2scan;
mod mgga_c_tpss;
mod mgga_x_m06_l;
mod mgga_x_r2scan;
mod mgga_x_tpss;

/// Build the boxed evaluator for a functional id. The full v0.1 set is
/// implemented, so this matches every [`FunctionalId`] variant explicitly (no
/// catch-all): adding a future variant deliberately fails to compile here until
/// it is wired up or routed to [`XcError::NotImplemented`].
pub(crate) fn build(id: FunctionalId) -> Result<Box<dyn XcEval>, XcError> {
    use FunctionalId::*;
    match id {
        LdaX => Ok(lda_x::LdaX::boxed()),
        LdaCPw => Ok(lda_c_pw::LdaCPw::boxed()),
        LdaCVwn => Ok(lda_c_vwn::LdaCVwn::boxed()),
        LdaCVwn3 => Ok(lda_c_vwn_3::LdaCVwn3::boxed()),
        LdaCVwnRpa => Ok(lda_c_vwn_rpa::LdaCVwnRpa::boxed()),
        GgaXPbe => Ok(gga_x_pbe::GgaXPbe::boxed()),
        GgaXB88 => Ok(gga_x_b88::GgaXB88::boxed()),
        GgaCPbe => Ok(gga_c_pbe::GgaCPbe::boxed()),
        GgaCLyp => Ok(gga_c_lyp::GgaCLyp::boxed()),
        GgaXPbeR => Ok(gga_x_pbe_r::GgaXPbeR::boxed()),
        GgaXPbeSol => Ok(gga_x_pbe_sol::GgaXPbeSol::boxed()),
        GgaXRpbe => Ok(gga_x_rpbe::GgaXRpbe::boxed()),
        GgaCPbeSol => Ok(gga_c_pbe_sol::GgaCPbeSol::boxed()),
        MggaXTpss => Ok(mgga_x_tpss::MggaXTpss::boxed()),
        MggaCTpss => Ok(mgga_c_tpss::MggaCTpss::boxed()),
        MggaXR2scan => Ok(mgga_x_r2scan::MggaXR2scan::boxed()),
        MggaCR2scan => Ok(mgga_c_r2scan::MggaCR2scan::boxed()),
        MggaXM06L => Ok(mgga_x_m06_l::MggaXM06L::boxed()),
        MggaCM06L => Ok(mgga_c_m06_l::MggaCM06L::boxed()),
        HybGgaXcPbeh => hybrids::pbeh(),
        HybGgaXcB3lyp5 => hybrids::b3lyp5(),
        HybGgaXcB3lyp => hybrids::b3lyp(),
    }
}