#!/usr/bin/env python
# Copyright 2014-2018 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.
#
# Author: Qiming Sun <osirpt.sun@gmail.com>
#
'''Wave Function Stability Analysis
Ref.
JCP, 66, 3045 (1977); DOI:10.1063/1.434318
JCP 104, 9047 (1996); DOI:10.1063/1.471637
'''
import numpy
import scipy
from pyscf import lib
from pyscf.lib import logger
from pyscf import ao2mo
from pyscf.scf.stability import dump_status
from pyscf.soscf import newton_ah
from pyscf.scf.hf import KohnShamDFT
[docs]
def rhf_stability(mf, internal=True, external=False, verbose=None):
if internal:
rhf_internal(mf, verbose)
if external:
rhf_external(mf, verbose)
[docs]
def uhf_stability(mf, internal=True, external=False, verbose=None):
if internal:
uhf_internal(mf, verbose)
if external:
uhf_external(mf, verbose)
[docs]
def rhf_internal(mf, verbose=None):
log = logger.new_logger(mf, verbose)
mol = mf.mol
mo_coeff = mf.mo_coeff
mo_energy = mf.mo_energy
mo_occ = mf.mo_occ
nmo = mo_coeff.shape[1]
nocc = numpy.count_nonzero(mo_occ)
nvir = nmo - nocc
eri_mo = ao2mo.full(mol, mo_coeff)
eri_mo = ao2mo.restore(1, eri_mo, nmo)
eai = lib.direct_sum('a-i->ai', mo_energy[nocc:], mo_energy[:nocc])
# A
h = numpy.einsum('ckld->kcld', eri_mo[nocc:,:nocc,:nocc,nocc:]) * 2
h-= numpy.einsum('cdlk->kcld', eri_mo[nocc:,nocc:,:nocc,:nocc])
for a in range(nvir):
for i in range(nocc):
h[i,a,i,a] += eai[a,i]
# B
h+= numpy.einsum('ckdl->kcld', eri_mo[nocc:,:nocc,nocc:,:nocc]) * 2
h-= numpy.einsum('cldk->kcld', eri_mo[nocc:,:nocc,nocc:,:nocc])
nov = nocc * nvir
e = scipy.linalg.eigh(h.reshape(nov,nov))[0]
log.debug('rhf_internal: lowest eigs = %s', e[e<=max(e[0],1e-5)])
if e[0] < -1e-5:
log.log('RHF wavefunction has an internal instability')
else:
log.log('RHF wavefunction is stable in the internal stability analysis')
[docs]
def rhf_external(mf, verbose=None):
log = logger.new_logger(mf, verbose)
mol = mf.mol
mo_coeff = mf.mo_coeff
mo_energy = mf.mo_energy
mo_occ = mf.mo_occ
nmo = mo_coeff.shape[1]
nocc = numpy.count_nonzero(mo_occ)
nvir = nmo - nocc
nov = nocc * nvir
eri_mo = ao2mo.full(mol, mo_coeff)
eri_mo = ao2mo.restore(1, eri_mo, nmo)
eai = lib.direct_sum('a-i->ai', mo_energy[nocc:], mo_energy[:nocc])
# A
h = numpy.einsum('ckld->kcld', eri_mo[nocc:,:nocc,:nocc,nocc:]) * 2
h-= numpy.einsum('cdlk->kcld', eri_mo[nocc:,nocc:,:nocc,:nocc])
for a in range(nvir):
for i in range(nocc):
h[i,a,i,a] += eai[a,i]
# B
h-= numpy.einsum('ckdl->kcld', eri_mo[nocc:,:nocc,nocc:,:nocc]) * 2
h+= numpy.einsum('cldk->kcld', eri_mo[nocc:,:nocc,nocc:,:nocc])
e1 = scipy.linalg.eigh(h.reshape(nov,nov))[0]
log.debug('rhf_external: lowest eigs = %s', e1[e1<=max(e1[0],1e-5)])
if e1[0] < -1e-5:
log.log('RHF wavefunction has an RHF real -> complex instability')
else:
log.log('RHF wavefunction is stable in the RHF real -> complex stability analysis')
h =-numpy.einsum('cdlk->kcld', eri_mo[nocc:,nocc:,:nocc,:nocc])
for a in range(nvir):
for i in range(nocc):
h[i,a,i,a] += eai[a,i]
h-= numpy.einsum('cldk->kcld', eri_mo[nocc:,:nocc,nocc:,:nocc])
e3 = scipy.linalg.eigh(h.reshape(nov,nov))[0]
log.debug('rhf_external: lowest eigs of H = %s', e3[e3<=max(e3[0],1e-5)])
if e3[0] < -1e-5:
log.log('RHF wavefunction has an RHF -> UHF instability.')
else:
log.log('RHF wavefunction is stable in the RHF -> UHF stability analysis')
[docs]
def uhf_internal(mf, verbose=None):
log = logger.new_logger(mf, verbose)
mol = mf.mol
mo_a, mo_b = mf.mo_coeff
mo_ea, mo_eb = mf.mo_energy
mo_occa, mo_occb = mf.mo_occ
nmo = mo_a.shape[1]
nocca = numpy.count_nonzero(mo_occa)
noccb = numpy.count_nonzero(mo_occb)
nvira = nmo - nocca
nvirb = nmo - noccb
eri_aa = ao2mo.restore(1, ao2mo.full(mol, mo_a), nmo)
eri_ab = ao2mo.restore(1, ao2mo.general(mol, [mo_a,mo_a,mo_b,mo_b]), nmo)
eri_bb = ao2mo.restore(1, ao2mo.full(mol, mo_b), nmo)
# alpha -> alpha
haa = numpy.einsum('aijb->iajb', eri_aa[nocca:,:nocca,:nocca,nocca:]) * 2
haa-= numpy.einsum('abji->iajb', eri_aa[nocca:,nocca:,:nocca,:nocca])
haa-= numpy.einsum('ajbi->iajb', eri_aa[nocca:,:nocca,nocca:,:nocca])
for a in range(nvira):
for i in range(nocca):
haa[i,a,i,a] += mo_ea[nocca+a] - mo_ea[i]
# beta -> beta
hbb = numpy.einsum('aijb->iajb', eri_bb[noccb:,:noccb,:noccb,noccb:]) * 2
hbb-= numpy.einsum('abji->iajb', eri_bb[noccb:,noccb:,:noccb,:noccb])
hbb-= numpy.einsum('ajbi->iajb', eri_bb[noccb:,:noccb,noccb:,:noccb])
for a in range(nvirb):
for i in range(noccb):
hbb[i,a,i,a] += mo_eb[noccb+a] - mo_eb[i]
# (alpha -> alpha, beta -> beta)
hab = numpy.einsum('aijb->iajb', eri_ab[nocca:,:nocca,:noccb,noccb:]) * 2
nova = nocca * nvira
novb = noccb * nvirb
hall = numpy.empty((nova+novb,nova+novb))
hall[:nova,:nova] = haa.reshape(nova,nova)
hall[nova:,nova:] = hbb.reshape(novb,novb)
hall[:nova,nova:] = hab.reshape(nova,novb)
hall[nova:,:nova] = hab.reshape(nova,novb).T
e = scipy.linalg.eigh(hall)[0]
log.debug('uhf_internal: lowest eigs of H = %s', e[e<=max(e[0],1e-5)])
if e[0] < -1e-5:
log.log('UHF wavefunction has an internal instability. '
'It maybe corresponds to (spatial) symmetry broken wfn.')
else:
log.log('UHF wavefunction is stable in the internal stability analysis')
[docs]
def uhf_external(mf, verbose=None):
log = logger.new_logger(mf, verbose)
mol = mf.mol
mo_a, mo_b = mf.mo_coeff
mo_ea, mo_eb = mf.mo_energy
mo_occa, mo_occb = mf.mo_occ
nmo = mo_a.shape[1]
nocca = numpy.count_nonzero(mo_occa)
noccb = numpy.count_nonzero(mo_occb)
nvira = nmo - nocca
nvirb = nmo - noccb
eri_aa = ao2mo.restore(1, ao2mo.full(mol, mo_a), nmo)
eri_ab = ao2mo.restore(1, ao2mo.general(mol, [mo_a,mo_a,mo_b,mo_b]), nmo)
eri_bb = ao2mo.restore(1, ao2mo.full(mol, mo_b), nmo)
# alpha -> alpha
haa =-numpy.einsum('abji->iajb', eri_aa[nocca:,nocca:,:nocca,:nocca])
haa+= numpy.einsum('ajbi->iajb', eri_aa[nocca:,:nocca,nocca:,:nocca])
for a in range(nvira):
for i in range(nocca):
haa[i,a,i,a] += mo_ea[nocca+a] - mo_ea[i]
# beta -> beta
hbb =-numpy.einsum('abji->iajb', eri_bb[noccb:,noccb:,:noccb,:noccb])
hbb+= numpy.einsum('ajbi->iajb', eri_bb[noccb:,:noccb,noccb:,:noccb])
for a in range(nvirb):
for i in range(noccb):
hbb[i,a,i,a] += mo_eb[noccb+a] - mo_eb[i]
nova = nocca * nvira
novb = noccb * nvirb
hall = numpy.zeros((nova+novb,nova+novb))
hall[:nova,:nova] = haa.reshape(nova,nova)
hall[nova:,nova:] = hbb.reshape(novb,novb)
e1 = scipy.linalg.eigh(hall)[0]
log.debug('uhf_external: lowest eigs of H = %s', e1[e1<=max(e1[0],1e-5)])
if e1[0] < -1e-5:
log.log('UHF wavefunction has an UHF real -> complex instability')
else:
log.log('UHF wavefunction is stable in the UHF real -> complex stability analysis')
h11 =-numpy.einsum('abji->iajb', eri_ab[nocca:,nocca:,:noccb,:noccb])
for a in range(nvira):
for i in range(noccb):
h11[i,a,i,a] += mo_ea[nocca+a] - mo_eb[i]
h22 =-numpy.einsum('jiab->iajb', eri_ab[:nocca,:nocca,noccb:,noccb:])
for a in range(nvirb):
for i in range(nocca):
h22[i,a,i,a] += mo_eb[noccb+a] - mo_ea[i]
h12 =-numpy.einsum('ajbi->iajb', eri_ab[nocca:,:nocca,noccb:,:noccb])
h21 =-numpy.einsum('biaj->iajb', eri_ab[nocca:,:nocca,noccb:,:noccb])
n1 = noccb * nvira
n2 = nocca * nvirb
hall = numpy.empty((n1+n2,n1+n2))
hall[:n1,:n1] = h11.reshape(n1,n1)
hall[n1:,n1:] = h22.reshape(n2,n2)
hall[:n1,n1:] = h12.reshape(n1,n2)
hall[n1:,:n1] = h21.reshape(n2,n1)
e3 = scipy.linalg.eigh(hall)[0]
log.debug('uhf_external: lowest eigs of H = %s', e3[e3<=max(e3[0],1e-5)])
if e3[0] < -1e-5:
log.log('UHF wavefunction has an UHF -> GHF instability.')
else:
log.log('UHF wavefunction is stable in the UHF -> GHF stability analysis')
[docs]
def ghf_internal(mf, return_status=False, verbose=None):
'''
GHF internal stability analysis.
Args:
mf : GHF object
Kwargs:
return_status: bool
Whether to return `stable_i` and `stable_e`
Returns:
If return_status is False (default), the return value includes
a new set of orbitals, which are more close to the stable condition.
Else, a tuple of orbitals with a boolean value `stable` is returned.
'''
log = logger.new_logger(mf, verbose)
if isinstance(mf, KohnShamDFT):
log.warn('ghf_internal: Hessian does not include XC contributions.')
mo_energy = mf.mo_energy
mo_coeff = mf.mo_coeff
mo_occ = mf.mo_occ
mol = mf.mol
nmo = mo_occ.size
nao = mol.nao
occidx = numpy.where(mo_occ==1)[0]
viridx = numpy.where(mo_occ==0)[0]
orbv = mo_coeff[:,viridx]
orbo = mo_coeff[:,occidx]
nvir = orbv.shape[1]
nocc = orbo.shape[1]
mo = numpy.hstack((orbo,orbv))
moa = mo[:nao].copy()
mob = mo[nao:].copy()
orboa = orbo[:nao]
orbob = orbo[nao:]
nmo = nocc + nvir
e_ia = mo_energy[viridx] - mo_energy[occidx,None]
a = numpy.diag(e_ia.ravel()).reshape(nocc,nvir,nocc,nvir).astype(mo_coeff.dtype)
b = numpy.zeros_like(a)
if mo_coeff.dtype == numpy.double:
eri_mo = ao2mo.general(mol, [orboa,moa,moa,moa], compact=False)
eri_mo += ao2mo.general(mol, [orbob,mob,mob,mob], compact=False)
eri_mo += ao2mo.general(mol, [orboa,moa,mob,mob], compact=False)
eri_mo += ao2mo.general(mol, [orbob,mob,moa,moa], compact=False)
eri_mo = eri_mo.reshape(nocc,nmo,nmo,nmo)
else:
eri_ao = mol.intor('int2e').reshape([nao]*4)
eri_mo_a = lib.einsum('pqrs,pi,qj->ijrs', eri_ao, orboa.conj(), moa)
eri_mo_a+= lib.einsum('pqrs,pi,qj->ijrs', eri_ao, orbob.conj(), mob)
eri_mo = lib.einsum('ijrs,rk,sl->ijkl', eri_mo_a, moa.conj(), moa)
eri_mo+= lib.einsum('ijrs,rk,sl->ijkl', eri_mo_a, mob.conj(), mob)
# The orbital hessian is constructed as (ai|jb) in soscf/newton_ah.py
# (ai|jb) == iabj.conj()
a += numpy.einsum('iabj->iajb', eri_mo[:nocc,nocc:,nocc:,:nocc].conj())
a -= numpy.einsum('ijba->iajb', eri_mo[:nocc,:nocc,nocc:,nocc:].conj())
b += numpy.einsum('iajb->iajb', eri_mo[:nocc,nocc:,:nocc,nocc:].conj())
b -= numpy.einsum('jaib->iajb', eri_mo[:nocc,nocc:,:nocc,nocc:].conj())
a = a.reshape(nocc*nvir, nocc*nvir)
b = b.reshape(nocc*nvir, nocc*nvir)
hessian = numpy.block([[a,b],[b.conj(),a.conj()]])
# This factor is necessary to replicate the eigenvalues of ghf_stability
hessian *= 2
e, v = scipy.linalg.eigh(hessian)
log.info('ghf_internal: lowest eigs of H = %s', e[:5])
e = e[0]
v = v[:,0]
stable = not (e < -1e-5)
dump_status(log, stable, f'{mf.__class__}', 'internal')
mo = mf.mo_coeff
if not stable:
occidx = numpy.where(mf.mo_occ > 0)[0]
viridx = numpy.where(mf.mo_occ == 0)[0]
nocc = len(occidx)
nvir = len(viridx)
nmo = nocc+nvir
dx = numpy.zeros((nmo,nmo), dtype=mf.mo_coeff.dtype)
dx[occidx[:,None],viridx] = v[:nocc*nvir].reshape(nocc,nvir).conj()
dx[occidx[:,None],viridx]+= v[nocc*nvir:].reshape(nocc,nvir).conj()
u = newton_ah.expmat(dx - dx.conj().T)
mo = numpy.dot(mo, u)
if return_status:
return mo, stable
else:
return mo
if __name__ == '__main__':
from pyscf import gto, scf
mol = gto.M(atom='O 0 0 0; O 0 0 1.2222', basis='631g*')
mf = scf.RHF(mol).run()
rhf_stability(mf, True, True, verbose=5)
mf = scf.UHF(mol).run()
uhf_stability(mf, not True, True, verbose=5)
mol.spin = 2
mf = scf.UHF(mol).run()
uhf_stability(mf, True, True, verbose=5)
mol = gto.M(atom='''
O1
O2 1 1.2227
O3 1 1.2227 2 114.0451
''', basis = '631g*')
mf = scf.RHF(mol).run()
rhf_stability(mf, True, True, verbose=5)
mf = scf.UHF(mol).run()
uhf_stability(mf, True, True, verbose=5)