sc::Wavefunction(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🦋 sc::Wavefunction(3) 🦋

okay bestie, this is the MPQC manual page for sc::Wavefunction(3). It's giving computational chemistry main character energy, and yes, we're covering every single member function. No skips, no cap. 💅

🌸 NAME 🌸

sc::Wavefunction — A Wavefunction is a MolecularEnergy that utilizies a GaussianBasisSet.

✨ SYNOPSIS ✨

#include <wfn.h>

Inherits sc::MolecularEnergy.

Inherited by sc::MBPT2, sc::OneBodyWavefunction, and sc::PsiWavefunction.

💖 Public Member Functions 💖

Here's the whole roster, bestie — every signature stays exactly as written. No merging, no renaming, no "helpful" little edits. 🫶

  • Wavefunction (StateIn &) — the StateIn constructor. The page gives no extra one-liner here.
  • Wavefunction (const Ref< KeyVal > &) — the KeyVal constructor. Its parameters are down in the constructor docs.
  • void save_data_state (StateOut &) — saves the base classes with save_data_state and the members in the same order that the StateIn CTOR initializes them.
  • double density (const SCVector3 &) — signature only on the page.
  • double density_gradient (const SCVector3 &, double *) — signature only.
  • double natural_orbital (const SCVector3 &r, int iorb) — signature only.
  • double natural_orbital_density (const SCVector3 &r, int orb, double *orbval=0) — signature only.
  • double orbital (const SCVector3 &r, int iorb, const RefSCMatrix &orbs) — signature only.
  • double orbital_density (const SCVector3 &r, int iorb, const RefSCMatrix &orbs, double *orbval=0) — signature only.
  • double charge () — hands back the charge.
  • virtual int nelectron ()=0 — gives you the number of electrons.
  • virtual RefSymmSCMatrix density ()=0 — gives you the SO density.
  • virtual RefSymmSCMatrix ao_density () — gives you the AO density.
  • virtual RefSCMatrix natural_orbitals () — gives you the natural orbitals.
  • virtual RefDiagSCMatrix natural_density () — gives you the natural density, and it's a diagonal matrix.
  • virtual int spin_polarized ()=0 — returns 1 if the alpha density is not equal to the beta density.
  • virtual RefSymmSCMatrix alpha_density () — alpha electron densities in the SO basis.
  • virtual RefSymmSCMatrix beta_density () — beta electron densities in the SO basis.
  • virtual RefSymmSCMatrix alpha_ao_density () — alpha electron densities in the AO basis.
  • virtual RefSymmSCMatrix beta_ao_density () — beta electron densities in the AO basis.
  • virtual RefSCMatrix nao (double *atom_charges=0) — returns the ao to nao transformation matrix.
  • virtual RefSymmSCMatrix overlap () — returns the SO overlap matrix.
  • virtual RefSymmSCMatrix core_hamiltonian () — returns the SO core Hamiltonian.
  • virtual double nuclear_repulsion_energy () — returns the nuclear repulsion energy.
  • void nuclear_repulsion_energy_gradient (double *g) — computes the nuclear repulsion gradient.
  • virtual void nuclear_repulsion_energy_gradient (double **g) — computes the nuclear repulsion gradient. Yep, it's an overload — both are here.
  • RefSCDimension ao_dimension () — atomic orbital dimension.
  • RefSCDimension so_dimension () — symmetry adapted orbital dimension.
  • RefSCDimension oso_dimension () — orthogonalized symmetry adapted orbital dimension.
  • Ref< SCMatrixKit > basis_matrixkit () — matrix kit for AO, SO, orthogonalized SO, and MO dimensioned matrices.
  • Ref< Molecule > molecule () const — returns the Molecule.
  • Ref< GaussianBasisSet > basis () const — returns the basis set.
  • Ref< GaussianBasisSet > atom_basis () const — returns the basis set describing the nuclear charge distributions.
  • const double * atom_basis_coef () const — returns the coefficients of the nuclear charge distribution basis functions.
  • Ref< Integral > integral () — returns the integral evaluator.
  • void symmetry_changed () — call this if you have changed the molecular symmetry of the molecule contained by this MolecularEnergy.
  • RefSCMatrix so_to_orthog_so () — returns a matrix which does the default transform from SO's to orthogonal SO's.
  • RefSCMatrix so_to_orthog_so_inverse () — returns the inverse of the transformation returned by so_to_orthog_so.
  • OverlapOrthog::OrthogMethod orthog_method () const — returns the orthogonalization method.
  • void set_orthog_method (const OverlapOrthog::OrthogMethod &) — (Re)Sets the orthogonalization method and makes this obsolete.
  • double lindep_tol () const — returns the tolerance for linear dependencies.
  • void set_lindep_tol (double) — Re(Sets) the tolerance for linear dependencies.
  • void obsolete () — marks all results as being out of date.
  • void print (std::ostream &=ExEnv::out0()) const — prints information about the object.

🛡️ Protected Member Functions 🛡️

  • double min_orthog_res () — no extra description on the page.
  • double max_orthog_res () — same, signature only.
  • void copy_orthog_info (const Ref< Wavefunction > &) — also signature only.

🧚 Protected Attributes 🧚

  • int debug_ — the protected debug attribute.

🌈 Additional Inherited Members 🌈

This heading is in the page, and there are no extra inherited members listed underneath it. That's the whole section, bestie — I'm not hiding anything from you.

🌟 Detailed Description 🌟

A Wavefunction is a MolecularEnergy that utilizies a GaussianBasisSet.

🎀 Constructor & Destructor Documentation 🎀

🫶 sc::Wavefunction::Wavefunction (const Ref< KeyVal > &)

This is the KeyVal constructor. Here's what the parameters mean:

  • basis — specifies a GaussianBasisSet object. There is no default.
  • integral — specifies an Integral object that computes the two electron integrals. The default is a IntegralV3 object.
  • orthog_method — this is a string that specifies the orthogonalization method to be used. It can be one one canonical, gramschmidt, or symmetric. The default is symmetric.
  • lindep_tol — the tolerance used to detect linearly dependent basis functions. The precise meaning depends on the orthogonalization method. The default value is 1e-8.
  • print_nao — this specifies a boolean value. If true the natural atomic orbitals will be printed. Not all wavefunction will be able to do this. The default is false.
  • print_npa — this specifies a boolean value. If true the natural population analysis will be printed. Not all wavefunction will be able to do this. The default is true if print_nao is true, otherwise it is false.
  • debug — this integer can be used to produce output for debugging. The default is 0.

🔥 Member Function Documentation 🔥

💫 virtual double sc::Wavefunction::nuclear_repulsion_energy () [virtual]

Returns the nuclear repulsion energy. This must be used instead of Molecule::nuclear_repulsion_energy() since there may be diffuse atomic charges.

💫 virtual void sc::Wavefunction::nuclear_repulsion_energy_gradient (double ** g) [virtual]

Computes the nuclear repulsion gradient. This must be used instead of Molecule::nuclear_repulsion_1der() since there may be diffuse atomic charges. The gradient, g, is first zeroed. Its dimensions are g[natom][3].

💫 void sc::Wavefunction::nuclear_repulsion_energy_gradient (double * g)

Computes the nuclear repulsion gradient. This must be used instead of Molecule::nuclear_repulsion_1der() since there may be diffuse atomic charges. The gradient, g, is zeroed and set to x_0, y_0, z_0, x_1, ... .

♻️ void sc::Wavefunction::obsolete () [virtual]

Marks all results as being out of date. Any subsequent access to results will cause Compute::compute() to be called.

Reimplemented from sc::Compute.

💾 void sc::Wavefunction::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.

🦋 RefSCMatrix sc::Wavefunction::so_to_orthog_so ()

Returns a matrix which does the default transform from SO's to orthogonal SO's. This could be either the symmetric or canonical orthogonalization matrix. The row dimension is SO and the column dimension is ortho SO. An operator $O$ in the ortho SO basis is given by $X O X^T$ where $X$ is the return value of this function.

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code.

Okay bestie, that's the whole page. Source/version: Version 2.3.1; date: Sun Oct 4 2020; manual: sc::Wavefunction(3). Stay slay and orthogonalized. 💅✨

📦 where this page comes from