hqs_nmr.solver.implementations.nmr_solver

Different solvers to evaluate individual spectral contributions of a NMR Spin Hamiltonian.

Functions

nmr_solver(hamiltonian, ...)

Calculate a NMR spectrum exploiting Sz conservation given a SpinHamiltonianSystem.

nmr_solver_local_su2(hamiltonian, ...)

Calculate a NMR spectrum using Sz and local SU2 conservation given a SpinHamiltonianSystem.
hqs_nmr.solver.implementations.nmr_solver.nmr_solver(hamiltonian: SpinHamiltonianSystem, normalized_gyromagnetic_ratios: np.ndarray, omegas: np.ndarray, eta: np.ndarray, spin_contribution_indices: list[int], calculation_parameters: NMRCalculationParameters, **kwargs: dict[str, Any]) → np.ndarray[source]

Calculate a NMR spectrum exploiting Sz conservation given a SpinHamiltonianSystem.

Evaluates a correlator function of the form: .. math:: sum_n frac{bra{n} I^+_l ket{m} bra{m} I^- ket{n}}{omega + E_n - E_m + i eta} text{where} I^- = sum_l I^-_l.

Parameters:

  • hamiltonian – Struqture spin Hamiltonian.

  • normalized_gyromagnetic_ratios – Array of the gyromagnetic factors per site, normalized with respect to the reference isotope.

  • omegas – Desired frequencies.

  • eta – Explicit spin-dependent broadening of the peaks.

  • spin_contribution_indices – List of indices l of I^+_l for which to evaluate the correlator.

  • calculation_parameters – Object storing all calculation parameters including solver-specific settings.

  • kwargs – Catch all for general interface.

Returns:

An array of the spectral function for the specified spin contributions at each frequency.

Raises:

ValueError – if number of spins does not match the number of gyromagnetic factors.

hqs_nmr.solver.implementations.nmr_solver.nmr_solver_local_su2(hamiltonian: SpinHamiltonianSystem, normalized_gyromagnetic_ratios: np.ndarray, omegas: np.ndarray, eta: np.ndarray, spin_contribution_indices: list[int], calculation_parameters: NMRCalculationParameters, **kwargs: dict[str, Any]) → np.ndarray[source]

Calculate a NMR spectrum using Sz and local SU2 conservation given a SpinHamiltonianSystem.

Evaluates a correlator function of the form .. math:: sum_n frac{bra{n} I^+_l ket{m} bra{m} I^- ket{n}}{omega + E_n - E_m + i eta} text{where} I^- = sum_l I^-_l.

Parameters:

  • hamiltonian – Struqture spin Hamiltonian.

  • normalized_gyromagnetic_ratios – Array of the gyromagnetic factors per site, normalized with respect to the reference isotope.

  • omegas – Desired frequencies.

  • eta – Explicit spin-dependent broadening of the peaks.

  • spin_contribution_indices – List of indices for which to evaluate the correlator.

  • calculation_parameters – Object storing all calculation parameters including solver-specific settings.

  • kwargs – Catch all for general interface.

Returns:

An array with the correlator function for the specified spin contributions at each frequency.

Raises:

ValueError – if number of spins does not match the number of gyromagnetic factors.