MADNESS 0.10.1
madness::Slater Class Reference

A nuclear correlation factor class. More...

#include <correlationfactor.h>

Inheritance diagram for madness::Slater:
Collaboration diagram for madness::Slater:

Public Member Functions

 Slater (World &world, const Molecule &mol, const double a)
 ctor
corrfactype type () const override
Public Member Functions inherited from madness::NuclearCorrelationFactor
 NuclearCorrelationFactor (World &world, const Molecule &mol)
 ctor
virtual ~NuclearCorrelationFactor ()
 virtual destructor
const std::vector< size_t > & all_atoms () const
 indices of all atoms
virtual real_function_3d apply_U (const real_function_3d &rhs) const
 apply the regularized potential U_nuc on a given function rhs
std::vector< size_t > atoms_near (const double *x, const double *y, const double *z, const int npts) const
 atoms whose screening sphere meets the bounding sphere of a set of points
coord_3d dsmoothed_unitvec (const coord_3d &xyz, const int axis, double smoothing=0.0) const
 derivative of smoothed unit vector wrt the electronic coordinate
virtual real_function_3d function () const
 return the nuclear correlation factor
void initialize (const double vtol1)
 initialize the regularized potentials U1 and U2
virtual real_function_3d inverse () const
 return the inverse nuclear correlation factor
coord_3d smoothed_unitvec (const coord_3d &xyz, double smoothing=0.0) const
 smoothed unit vector for the computation of the U1 potential
virtual real_function_3d square () const
 return the square of the nuclear correlation factor
virtual real_function_3d square_times_V_derivative (const int iatom, const int axis) const
virtual const real_function_3d U1 (const int axis) const
 return the U1 term of the correlation function
std::vector< real_function_3d > U1vec () const
 return the U1 functions in a vector
virtual const real_function_3d U2 () const
 return the U2 term of the correlation function

Private Member Functions

double a_param () const
double eprec_param () const
double S (const double &r, const double &Z) const override
 the nuclear correlation factor
double screening_radius (const double Z) const override
 every per-atom term of this factor decays as exp(-a Z r); 1e-14 relative to (a Z)^2
coord_3d Sp (const coord_3d &vr1A, const double &Z) const override
 radial part first derivative of the nuclear correlation factor
double Spp_div_S (const double &r, const double &Z) const override
 second derivative of the nuclear correlation factor
double Sr_div_S (const double &r, const double &Z) const override
 first derivative of the correlation factor wrt (r-R_A)
double Srr_div_S (const double &r, const double &Z) const override
 second derivative of the correlation factor wrt (r-R_A)
double Srrr_div_S (const double &r, const double &Z) const override
 third derivative of the correlation factor wrt (r-R_A)
double U2X_spherical (const double &r, const double &Z, const double &rcut) const override
 derivative of the U2 potential wrt X (scalar part)

Private Attributes

double a_
 the length scale parameter
double eprec_

Additional Inherited Members

Public Types inherited from madness::NuclearCorrelationFactor
enum  corrfactype {
  None , GradientalGaussSlater , GaussSlater , LinearSlater ,
  Polynomial , Slater , poly4erfc , Two ,
  Adhoc
}
typedef std::shared_ptr< FunctionFunctorInterface< double, 3 > > functorT
Static Public Attributes inherited from madness::NuclearCorrelationFactor
static constexpr int ncf_special_level =15
 projection depth of the factor's functions at the nuclei
Protected Attributes inherited from madness::NuclearCorrelationFactor
std::vector< real_function_3d > U1_function
 the three components of the U1 potential
real_function_3d U2_function
 the purely local U2 potential, having absorbed the nuclear pot V_nuc

Detailed Description

A nuclear correlation factor class.

Constructor & Destructor Documentation

◆ Slater()

madness::Slater::Slater ( World & world,
const Molecule & mol,
const double a )
inline

ctor

Parameters
[in]worldthe world
[in]molmolecule with the sites of the nuclei

References madness::NuclearCorrelationFactor::NuclearCorrelationFactor(), a, a_, eprec_, madness::Molecule::get_eprec(), and madness::NuclearCorrelationFactor::world.

Member Function Documentation

◆ a_param()

double madness::Slater::a_param ( ) const
inlineprivate

◆ eprec_param()

double madness::Slater::eprec_param ( ) const
inlineprivate

References eprec_.

◆ S()

double madness::Slater::S ( const double & r,
const double & Z ) const
inlineoverrideprivatevirtual

the nuclear correlation factor

Implements madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ screening_radius()

double madness::Slater::screening_radius ( const double Z) const
inlineoverrideprivatevirtual

every per-atom term of this factor decays as exp(-a Z r); 1e-14 relative to (a Z)^2

Reimplemented from madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ Sp()

coord_3d madness::Slater::Sp ( const coord_3d & vr1A,
const double & Z ) const
inlineoverrideprivatevirtual

radial part first derivative of the nuclear correlation factor

Implements madness::NuclearCorrelationFactor.

References a, a_param(), madness::Vector< T, N >::normf(), madness::NuclearCorrelationFactor::smoothed_unitvec(), and Z.

◆ Spp_div_S()

double madness::Slater::Spp_div_S ( const double & r,
const double & Z ) const
inlineoverrideprivatevirtual

second derivative of the nuclear correlation factor

Implements madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ Sr_div_S()

double madness::Slater::Sr_div_S ( const double & r,
const double & Z ) const
inlineoverrideprivatevirtual

first derivative of the correlation factor wrt (r-R_A)

\‍[    Sr_div_S = \frac{1}{S(r)}\frac{\partial S(r)}{\partial r}
\‍]

Implements madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ Srr_div_S()

double madness::Slater::Srr_div_S ( const double & r,
const double & Z ) const
inlineoverrideprivatevirtual

second derivative of the correlation factor wrt (r-R_A)

\‍[    result = \frac{1}{S(r)}\frac{\partial^2 S(r)}{\partial r^2}
\‍]

Implements madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ Srrr_div_S()

double madness::Slater::Srrr_div_S ( const double & r,
const double & Z ) const
inlineoverrideprivatevirtual

third derivative of the correlation factor wrt (r-R_A)

\‍[   result = \frac{1}{S(r)}\frac{\partial^3 S(r)}{\partial r^3}
\‍]

Implements madness::NuclearCorrelationFactor.

References a, a_param(), and Z.

◆ type()

corrfactype madness::Slater::type ( ) const
inlineoverridevirtual

◆ U2X_spherical()

double madness::Slater::U2X_spherical ( const double & r,
const double & Z,
const double & rcut ) const
inlineoverrideprivatevirtual

derivative of the U2 potential wrt X (scalar part)

with

\‍[  \rho = \left| \vec r- \vec R_A \right|
\‍]

returns the term in the parenthesis without the the derivative of rho

\‍[\frac{\partial U_2}{\partial X_A} = \frac{\partial \rho}{\partial X}
          \left(-\frac{1}{2}\frac{S''' S - S'' S'}{S^2} + \frac{1}{\rho^2}\frac{S'}{S}
          - \frac{1}{\rho} \frac{S''S - S'^2}{S^2} + \frac{Z_A}{\rho^2}\right)
\‍]

Reimplemented from madness::NuclearCorrelationFactor.

References a, a2, a_param(), madness::r2(), rcut, madness::NuclearCorrelationFactor::Sr_div_S(), madness::NuclearCorrelationFactor::Srr_div_S(), madness::NuclearCorrelationFactor::Srrr_div_S(), and Z.

Member Data Documentation

◆ a_

double madness::Slater::a_
private

the length scale parameter

Referenced by Slater(), and a_param().

◆ eprec_

double madness::Slater::eprec_
private

Referenced by Slater(), and eprec_param().


The documentation for this class was generated from the following file: