sci-form 0.15.2

High-performance 3D molecular conformer generation using ETKDG distance geometry
Documentation
//! Types for advanced spectroscopy methods.
//!
//! Self-contained types that avoid dependency on experimental_2::types.

use nalgebra::DMatrix;
use serde::{Deserialize, Serialize};

/// Converged SCF data needed by spectroscopy methods.
///
/// A lightweight input struct that can be constructed from any SCF solver
/// (HF-3c, PM3, EHT, xTB) without coupling to a specific implementation.
#[derive(Debug, Clone)]
pub struct ScfInput {
    /// Orbital energies sorted ascending (Hartree).
    pub orbital_energies: Vec<f64>,
    /// MO coefficient matrix C (n_basis × n_basis).
    pub mo_coefficients: DMatrix<f64>,
    /// Density matrix P (n_basis × n_basis).
    pub density_matrix: DMatrix<f64>,
    /// Overlap matrix S (n_basis × n_basis).
    pub overlap_matrix: DMatrix<f64>,
    /// Number of basis functions.
    pub n_basis: usize,
    /// Number of electrons.
    pub n_electrons: usize,
}

impl From<crate::scf::types::ScfResult> for ScfInput {
    fn from(scf: crate::scf::types::ScfResult) -> Self {
        Self {
            orbital_energies: scf.orbital_energies,
            mo_coefficients: scf.mo_coefficients,
            density_matrix: scf.density_matrix,
            overlap_matrix: scf.overlap_matrix,
            n_basis: scf.n_basis,
            n_electrons: scf.n_electrons,
        }
    }
}

impl<'a> From<&'a crate::scf::types::ScfResult> for ScfInput {
    fn from(scf: &'a crate::scf::types::ScfResult) -> Self {
        Self {
            orbital_energies: scf.orbital_energies.clone(),
            mo_coefficients: scf.mo_coefficients.clone(),
            density_matrix: scf.density_matrix.clone(),
            overlap_matrix: scf.overlap_matrix.clone(),
            n_basis: scf.n_basis,
            n_electrons: scf.n_electrons,
        }
    }
}

/// Information about a single electronic transition (UV-Vis).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TransitionInfo {
    /// Excitation energy (eV).
    pub energy_ev: f64,
    /// Wavelength (nm).
    pub wavelength_nm: f64,
    /// Oscillator strength (dimensionless).
    pub oscillator_strength: f64,
    /// Transition dipole moment [x, y, z] in atomic units.
    pub transition_dipole: [f64; 3],
}

/// Result of sTDA UV-Vis calculation.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SpectroscopyResult {
    /// Electronic transitions with energies and oscillator strengths.
    pub transitions: Vec<TransitionInfo>,
    /// Method used.
    pub method: String,
}

/// NMR shielding tensor for a single nucleus.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ShieldingTensor {
    /// Atom index.
    pub atom_index: usize,
    /// Element (atomic number).
    pub element: u8,
    /// 3×3 shielding tensor (ppm).
    pub tensor: [[f64; 3]; 3],
    /// Isotropic shielding σ_iso = Tr(σ)/3 (ppm).
    pub isotropic: f64,
    /// Anisotropic shielding (ppm).
    pub anisotropy: f64,
    /// Chemical shift δ = σ_ref − σ (ppm).
    pub chemical_shift: f64,
}

/// Result of GIAO NMR calculation.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct NmrShieldingResult {
    /// Chemical shifts (ppm) per atom.
    pub chemical_shifts: Vec<f64>,
    /// Element types (atomic numbers).
    pub elements: Vec<u8>,
    /// Number of atoms.
    pub n_atoms: usize,
}