Analytical Gradients for DFT+U

gpu4pyscf/dft/rkspu.py

@@ -0,0 +1,350 @@
+#!/usr/bin/env python
+# Copyright 2025 The PySCF Developers. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+'''
+DFT+U for molecules
+
+See also the pbc.dft.krkspu and pbc.dft.kukspu module
+
+Refs:
+    Heather J. Kulik, J. Chem. Phys. 142, 240901 (2015)
+'''
+
+import itertools
+import numpy as np
+import cupy as cp
+from pyscf import gto
+from pyscf.data.nist import HARTREE2EV
+from pyscf.lo.iao import reference_mol
+from gpu4pyscf.dft import rks
+from gpu4pyscf.lib import logger
+from gpu4pyscf.lib.cupy_helper import asarray
+
+def get_veff(ks, mol=None, dm=None, dm_last=0, vhf_last=0, hermi=1):
+    """
+    Coulomb + XC functional + Hubbard U terms for RKS+U.
+
+    .. note::
+        This function will change the ks object.
+
+    Args:
+        ks : an instance of :class:`RKS`
+            XC functional are controlled by ks.xc attribute.  Attribute
+            ks.grids might be initialized.
+        dm : ndarray or list of ndarrays
+            A density matrix or a list of density matrices
+
+    Returns:
+        Veff : ``(nao, nao)`` or ``(*, nao, nao)`` ndarray
+        Veff = J + Vxc + V_U.
+    """
+    if mol is None: mol = ks.mol
+    if dm is None: dm = ks.make_rdm1()
+
+    # J + V_xc
+    vxc = rks.get_veff(ks, mol, dm, dm_last=dm_last, vhf_last=vhf_last,
+                       hermi=hermi)
+
+    # V_U
+    ovlp = asarray(mol.intor('int1e_ovlp', hermi=1))
+    pmol = reference_mol(mol, ks.minao_ref)
+    U_idx, U_val, U_lab = _set_U(mol, pmol, ks.U_idx, ks.U_val)
+    # Construct orthogonal minao local orbitals.
+    assert ks.C_ao_lo is None
+    C_ao_lo = _make_minao_lo(mol, pmol)
+
+    alphas = ks.alpha
+    if not hasattr(alphas, '__len__'): # not a list or tuple
+        alphas = [alphas] * len(U_idx)
+
+    E_U = 0.0
+    logger.info(ks, "-" * 79)
+    lab_string = " "
+    with np.printoptions(precision=5, suppress=True, linewidth=1000):
+        for idx, val, lab, alpha in zip(U_idx, U_val, U_lab, alphas):
+            if ks.verbose >= logger.INFO:
+                lab_string = " "
+                for l in lab:
+                    lab_string += "%9s" %(l.split()[-1])
+                lab_sp = lab[0].split()
+                logger.info(ks, "local rdm1 of atom %s: ",
+                            " ".join(lab_sp[:2]) + " " + lab_sp[2][:2])
+            C_loc = C_ao_lo[:,idx]
+            SC = ovlp.dot(C_loc) # ~ C^{-1}
+            P = SC.conj().T.dot(dm).dot(SC)
+            loc_sites = P.shape[-1]
+            vhub_loc = (cp.eye(loc_sites) - P) * (val * 0.5)
+            if alpha is not None:
+                # The alpha perturbation is only applied to the linear term of
+                # the local density.
+                E_U += alpha * P.trace()
+                vhub_loc += cp.eye(loc_sites) * alpha
+            # vxc is a tagged array. The inplace updating avoids loosing the
+            # tagged attributes.
+            vxc[:] += SC.dot(vhub_loc).dot(SC.conj().T)
+            E_U += (val * 0.5) * (P.trace() - P.dot(P).trace() * 0.5)
+            logger.info(ks, "%s\n%s", lab_string, P)
+            logger.info(ks, "-" * 79)
+
+    E_U = E_U.real.get()[()]
+    if E_U < 0.0 and all(np.asarray(U_val) > 0):
+        logger.warn(ks, "E_U (%s) is negative...", E_U)
+    vxc.E_U = E_U
+    return vxc
+
+def energy_elec(mf, dm=None, h1e=None, vhf=None):
+    """
+    Electronic energy for RKSpU.
+    """
+    if dm is None: dm = mf.make_rdm1()
+    if h1e is None: h1e = mf.get_hcore()
+    if vhf is None: vhf = mf.get_veff(mf.mol, dm)
+    e1 = cp.einsum('ij,ji->', h1e, dm).get()[()].real
+    ecoul = vhf.ecoul.real
+    exc = vhf.exc.real
+    E_U = vhf.E_U
+    if isinstance(ecoul, cp.ndarray):
+        ecoul = ecoul.get()[()]
+    if isinstance(exc, cp.ndarray):
+        exc = exc.get()[()]
+    e2 = ecoul + exc + E_U
+    mf.scf_summary['e1'] = e1
+    mf.scf_summary['coul'] = ecoul
+    mf.scf_summary['exc'] = exc
+    mf.scf_summary['E_U'] = E_U
+    logger.debug(mf, 'E1 = %s  Ecoul = %s  Exc = %s  EU = %s', e1, ecoul, exc, E_U)
+    return e1+e2, e2
+
+def _groupby(inp, labels):
+    _, where, counts = np.unique(labels, return_index=True, return_counts=True)
+    return [inp[start:start+count] for start, count in zip(where, counts)]
+
+def _set_U(mol, minao_mol, U_idx, U_val):
+    """
+    Regularize the U_idx and U_val to each atom,
+    """
+    assert len(U_idx) == len(U_val)
+
+    ao_loc = minao_mol.ao_loc_nr()
+    dims = ao_loc[1:] - ao_loc[:-1]
+    # atm_ids labels the atom Id for each function
+    atm_ids = np.repeat(minao_mol._bas[:,gto.ATOM_OF], dims)
+
+    ao_labels = mol.ao_labels()
+    minao_labels = minao_mol.ao_labels()
+
+    U_indices = []
+    U_values = []
+    for i, idx in enumerate(U_idx):
+        if isinstance(idx, str):
+            lab_idx = minao_mol.search_ao_label(idx)
+            # Group basis functions centered on the same atom
+            for idxj in _groupby(lab_idx, atm_ids[lab_idx]):
+                U_indices.append(idxj)
+                U_values.append(U_val[i])
+        else:
+            # Map to MINAO indices
+            idx_minao = [minao_labels.index(ao_labels[i]) for i in idx]
+            U_indices.append(idx_minao)
+            U_values.append(U_val[i])
+
+    if len(U_indices) == 0:
+        logger.warn(mol, "No sites specified for Hubbard U. "
+                    "Please check if 'U_idx' is correctly specified")
+
+    U_values = np.asarray(U_values) / HARTREE2EV
+
+    U_labels = [[minao_labels[i] for i in idx] for idx in U_indices]
+    return U_indices, U_values, U_labels
+
+def _make_minao_lo(mol, minao_ref='minao'):
+    '''
+    Construct orthogonal minao local orbitals.
+    '''
+    if isinstance(minao_ref, str):
+        minao_mol = reference_mol(mol, minao_ref)
+    else:
+        minao_mol = minao_ref
+    ovlp = asarray(mol.intor('int1e_ovlp', hermi=1))
+    s12 = asarray(gto.intor_cross('int1e_ovlp', mol, minao_mol))
+    C_minao = cp.linalg.solve(ovlp, s12)
+    S0 = C_minao.T.dot(ovlp).dot(C_minao)
+    w2, v = cp.linalg.eigh(S0)
+    C_minao = C_minao.dot((v*cp.sqrt(1./w2)).dot(v.T))
+    return C_minao
+
+def _format_idx(idx_list):
+    string = ''
+    for k, g in itertools.groupby(enumerate(idx_list), lambda ix: ix[0] - ix[1]):
+        g = list(g)
+        if len(g) > 1:
+            string += '%d-%d, '%(g[0][1], g[-1][1])
+        else:
+            string += '%d, '%(g[0][1])
+    return string[:-2]
+
+def _print_U_info(mf, log):
+    mol = mf.mol
+    pmol = reference_mol(mol, mf.minao_ref)
+    U_idx, U_val, U_lab = _set_U(mol, pmol, mf.U_idx, mf.U_val)
+    alphas = mf.alpha
+    if not hasattr(alphas, '__len__'): # not a list or tuple
+        alphas = [alphas] * len(U_idx)
+    log.info("-" * 79)
+    log.info('U indices and values: ')
+    for idx, val, lab, alpha in zip(U_idx, U_val, U_lab, alphas):
+        log.info('%6s [%.6g eV] ==> %-100s', _format_idx(idx),
+                    val * HARTREE2EV, "".join(lab))
+        if alpha is not None:
+            log.info('              alpha for LR-cDFT %s (eV)',
+                     alpha * HARTREE2EV)
+    log.info("-" * 79)
+
+class RKSpU(rks.RKS):
+    """
+    DFT+U for RKS
+    """
+
+    _keys = {"U_idx", "U_val", "C_ao_lo", "U_lab", 'minao_ref', 'alpha'}
+
+    get_veff = get_veff
+    energy_elec = energy_elec
+    to_hf = NotImplemented
+
+    def __init__(self, mol, xc='LDA,VWN',
+                 U_idx=[], U_val=[], C_ao_lo=None, minao_ref='MINAO'):
+        """
+        Args:
+            U_idx: can be
+                   list of list: each sublist is a set indices for AO orbitals
+                                 (indcies corresponding to the large-basis-set mol).
+                   list of string: each string is one kind of LO orbitals,
+                                   e.g. ['Ni 3d', '1 O 2pz'].
+                   or a combination of these two.
+            U_val: a list of effective U [in eV], i.e. U-J in Dudarev's DFT+U.
+                   each U corresponds to one kind of LO orbitals, should have
+                   the same length as U_idx.
+            C_ao_lo: Customized LO coefficients, can be
+                     np.array, shape ((spin,), nao, nlo),
+            minao_ref: reference for minao orbitals, default is 'MINAO'.
+
+        Attributes:
+            U_idx: same as the input.
+            U_val: effectiv U-J [in AU]
+            C_ao_loc: np.array
+            alpha: the perturbation [in AU] used to compute U in LR-cDFT.
+                Refs: Cococcioni and de Gironcoli, PRB 71, 035105 (2005)
+        """
+        super().__init__(mol, xc=xc)
+
+        self.U_idx = U_idx
+        self.U_val = U_val
+        if isinstance(C_ao_lo, str):
+            assert C_ao_lo.upper() == 'MINAO'
+            C_ao_lo = None # API backward compatibility
+        self.C_ao_lo = C_ao_lo
+        self.minao_ref = minao_ref
+        # The perturbation (eV) used to compute U in LR-cDFT.
+        self.alpha = None
+
+    def dump_flags(self, verbose=None):
+        log = logger.new_logger(self, verbose)
+        super().dump_flags(log)
+        if log.verbose >= logger.INFO:
+            _print_U_info(self, log)
+        return self
+
+    def Gradients(self):
+        from gpu4pyscf.grad.rkspu import Gradients
+        return Gradients(self)
+
+    def nuc_grad_method(self):
+        return self.Gradients()
+
+def linear_response_u(mf_plus_u, alphalist=(0.02, 0.05, 0.08)):
+    '''
+    Refs:
+        [1] M. Cococcioni and S. de Gironcoli, Phys. Rev. B 71, 035105 (2005)
+        [2] H. J. Kulik, M. Cococcioni, D. A. Scherlis, and N. Marzari, Phys. Rev. Lett. 97, 103001 (2006)
+        [3] Heather J. Kulik, J. Chem. Phys. 142, 240901 (2015)
+        [4] https://hjkgrp.mit.edu/tutorials/2011-05-31-calculating-hubbard-u/
+        [5] https://hjkgrp.mit.edu/tutorials/2011-06-28-hubbard-u-multiple-sites/
+
+    Args:
+        alphalist :
+            alpha parameters (in eV) are the displacements for the linear
+            response calculations. For each alpha in this list, the DFT+U with
+            U=u0+alpha, U=u0-alpha are evaluated. u0 is the U value from the
+            reference mf_plus_u object, which will be treated as a standard DFT
+            functional.
+    '''
+    assert isinstance(mf_plus_u, RKSpU)
+    assert len(mf_plus_u.U_idx) > 0
+    if not mf_plus_u.converged:
+        mf_plus_u.run()
+    assert mf_plus_u.converged
+    # The bare density matrix without adding U
+    bare_dm = mf_plus_u.make_rdm1()
+
+    mf = mf_plus_u.copy()
+    log = logger.new_logger(mf)
+
+    alphalist = np.asarray(alphalist)
+    alphalist = np.append(-alphalist[::-1], alphalist)
+
+    mol = mf.mol
+    pmol = reference_mol(mol, mf.minao_ref)
+    U_idx, U_val, U_lab = _set_U(mol, pmol, mf.U_idx, mf.U_val)
+    # Construct orthogonal minao local orbitals.
+    assert mf.C_ao_lo is None
+    C_ao_lo = _make_minao_lo(mol, pmol)
+    ovlp = asarray(mol.intor('int1e_ovlp', hermi=1))
+    C_inv = []
+    for idx in U_idx:
+        c = C_ao_lo[:,idx]
+        C_inv.append(c.conj().T.dot(ovlp))
+
+    bare_occupancies = []
+    final_occupancies = []
+    for alpha in alphalist:
+        # All in atomic unit
+        mf.alpha = alpha / HARTREE2EV
+        mf.kernel(dm0=bare_dm)
+        local_occ = 0
+        for c in C_inv:
+            C_on_site = c.dot(mf.mo_coeff)
+            rdm1_lo = mf.make_rdm1(C_on_site, mf.mo_occ)
+            local_occ += rdm1_lo.trace()
+        final_occupancies.append(local_occ.get())
+
+        # The first iteration of SCF
+        fock = mf.get_fock(dm=bare_dm)
+        e, mo = mf.eig(fock, ovlp)
+        local_occ = 0
+        for c in C_inv:
+            C_on_site = c.dot(mo)
+            rdm1_lo = mf.make_rdm1(C_on_site, mf.mo_occ)
+            local_occ += rdm1_lo.trace()
+        bare_occupancies.append(local_occ.get())
+        log.info('alpha=%f bare_occ=%g final_occ=%g',
+                 alpha, bare_occupancies[-1], final_occupancies[-1])
+
+    chi0, occ0 = np.polyfit(alphalist, bare_occupancies, deg=1)
+    chif, occf = np.polyfit(alphalist, final_occupancies, deg=1)
+    log.info('Line fitting chi0 = %f x + %f', chi0, occ0)
+    log.info('Line fitting chif = %f x + %f', chif, occf)
+    Uresp = 1./chi0 - 1./chif
+    log.note('Uresp = %f, chi0 = %f, chif = %f', Uresp, chi0, chif)
+    return Uresp

gpu4pyscf/dft/tests/test_dftu.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# Copyright 2025 The PySCF Developers. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import unittest
+import numpy as np
+from pyscf import gto
+from gpu4pyscf.dft import rkspu, ukspu
+
+class KnownValues(unittest.TestCase):
+    def test_RKSpU_linear_response(self):
+        mol = gto.M(atom='''
+        O  0.   0.       0.
+        H  0.   -0.757   0.587
+        H  0.   0.757    0.587''', basis='6-31g')
+        mf = rkspu.RKSpU(mol, xc='pbe', U_idx=['O 2p'], U_val=[3.5])
+        mf.run()
+        u0 = rkspu.linear_response_u(mf)
+        assert abs(u0 - 5.8926) < 1e-2
+
+    def test_UKSpU_linear_response(self):
+        mol = gto.M(atom='''
+        O  0.   0.       0.
+        H  0.   -0.757   0.587
+        H  0.   0.757    0.587''', basis='6-31g')
+        mf = ukspu.UKSpU(mol, xc='pbe', U_idx=['O 2p'], U_val=[3.5])
+        mf.run()
+        u0 = ukspu.linear_response_u(mf)
+        assert abs(u0 - 5.8926) < 1e-2
+
+if __name__ == '__main__':
+    print("Full Tests for dft+U")
+    unittest.main()