sc::UKS(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ’– sc::UKS(3) β€” MPQC edition πŸ’–

🌸 NAME 🌸

sc::UKS β€” this provides a Kohn-Sham implementation for unrestricted-orbital open-shell systems. That's the whole vibe, bestie. πŸ’…


✨ SYNOPSIS ✨

#include <uks.h>

Inherits sc::UnrestrictedSCF.

πŸŽ€ Public Member Functions πŸŽ€

  • UKS (StateIn &) β€” constructor taking a StateIn &, periodt.
  • UKS (const Ref< KeyVal > &) β€” this KeyVal constructor reads the following keywords: πŸ‘€
  • void save_data_state (StateOut &) β€” save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
  • void print (std::ostream &o=ExEnv::out0()) const β€” print information about the object.
  • void two_body_energy (double &ec, double &ex) β€” signature is right there, bestie.
  • int value_implemented () const β€” information about the availability of values, gradients, and hessians.
  • int gradient_implemented () const β€” signature only on this page, no extra tea.

πŸ¦‹ Protected Member Functions πŸ¦‹

  • void ao_fock (double accuracy)
  • double scf_energy ()
  • Ref< SCExtrapData > extrap_data ()
  • void two_body_deriv (double *)
  • void init_vector ()
  • void done_vector ()

🌈 Protected Attributes 🌈

  • Ref< DenIntegrator > integrator_
  • Ref< DenFunctional > functional_
  • RefSymmSCMatrix vaxc_
  • RefSymmSCMatrix vbxc_
  • double exc_

🫢 Additional Inherited Members 🫢

The original page pops this heading in and then moves right along β€” no extra inherited members are spelled out here, bestie. πŸ’€


🌟 Detailed Description 🌟

This provides a Kohn-Sham implementation for unrestricted-orbital open-shell systems. Iconic. ✨


πŸ’œ Constructor & Destructor Documentation πŸ’œ

sc::UKS::UKS (const Ref< KeyVal > &)

This KeyVal constructor reads the following keywords:

  • integrator β€” specifies the DenIntegrator that will be used to integrate the density functional. The default is RadialAngularIntegrator.
  • functional β€” specifies the DenFunctional that will be used to compute the exchange/correlation contribution. There is no default.

πŸ”₯ Member Function Documentation πŸ”₯

void sc::UKS::save_data_state (StateOut &) [virtual]

Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. This must be implemented by the derived class if the class has data.

Reimplemented from sc::MolecularEnergy.


🌸 Author 🌸

Generated automatically by Doxygen for MPQC from the source code.


okay that's the whole page, bestie 🫢 β€” Version 2.3.1, Sun Oct 4 2020, sc::UKS(3). mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from