MPQC  2.3.1
Public Member Functions | List of all members
sc::IntegralCCA Class Reference

IntegralCCA provides an SC client for CCA IntegralEvaluator components. More...

#include <intcca.h>

Inheritance diagram for sc::IntegralCCA:
Inheritance graph
[legend]
Collaboration diagram for sc::IntegralCCA:
Collaboration graph
[legend]

Public Member Functions

 IntegralCCA (IntegralEvaluatorFactory eval_factory, bool use_opaque, const Ref< GaussianBasisSet > &b1=0, const Ref< GaussianBasisSet > &b2=0, const Ref< GaussianBasisSet > &b3=0, const Ref< GaussianBasisSet > &b4=0)
 This constructor is used when the framework is not embedded.
 
 IntegralCCA (StateIn &)
 
 IntegralCCA (const Ref< KeyVal > &)
 The KeyVal constructor. More...
 
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. More...
 
Integralclone ()
 Clones the given Integral factory. The new factory may need to have set_basis and set_storage to be called on it.
 
CartesianIternew_cartesian_iter (int)
 Return a CartesianIter object. More...
 
RedundantCartesianIternew_redundant_cartesian_iter (int)
 Return a RedundantCartesianIter object. More...
 
RedundantCartesianSubIternew_redundant_cartesian_sub_iter (int)
 Return a RedundantCartesianSubIter object. More...
 
SphericalTransformIternew_spherical_transform_iter (int l, int inv=0, int subl=-1)
 Return a SphericalTransformIter object. More...
 
const SphericalTransformspherical_transform (int l, int inv=0, int subl=-1)
 Return a SphericalTransform object. More...
 
Ref< OneBodyIntoverlap ()
 Return a OneBodyInt that computes the overlap.
 
Ref< OneBodyIntkinetic ()
 Return a OneBodyInt that computes the kinetic energy.
 
Ref< OneBodyIntpoint_charge (const Ref< PointChargeData > &=0)
 Return a OneBodyInt that computes the integrals for interactions with point charges.
 
Ref< OneBodyIntnuclear ()
 Return a OneBodyInt that computes the nuclear repulsion integrals. More...
 
Ref< OneBodyInthcore ()
 Return a OneBodyInt that computes the core Hamiltonian integrals.
 
Ref< OneBodyIntefield_dot_vector (const Ref< EfieldDotVectorData > &=0)
 Return a OneBodyInt that computes the electric field integrals dotted with a given vector.
 
Ref< OneBodyIntdipole (const Ref< DipoleData > &=0)
 Return a OneBodyInt that computes electric dipole moment integrals. More...
 
Ref< OneBodyIntquadrupole (const Ref< DipoleData > &=0)
 Return a OneBodyInt that computes electric quadrupole moment integrals. More...
 
Ref< OneBodyDerivIntoverlap_deriv ()
 Return a OneBodyDerivInt that computes overlap derivatives.
 
Ref< OneBodyDerivIntkinetic_deriv ()
 Return a OneBodyDerivInt that computes kinetic energy derivatives.
 
Ref< OneBodyDerivIntnuclear_deriv ()
 Return a OneBodyDerivInt that computes nuclear repulsion derivatives.
 
Ref< OneBodyDerivInthcore_deriv ()
 Return a OneBodyDerivInt that computes core Hamiltonian derivatives.
 
Ref< TwoBodyIntelectron_repulsion ()
 Return a TwoBodyInt that computes electron repulsion integrals.
 
Ref< TwoBodyDerivIntelectron_repulsion_deriv ()
 Return a TwoBodyDerivInt that computes electron repulsion derivatives.
 
void set_basis (const Ref< GaussianBasisSet > &b1, const Ref< GaussianBasisSet > &b2=0, const Ref< GaussianBasisSet > &b3=0, const Ref< GaussianBasisSet > &b4=0)
 Set the basis set for each center.
 
- Public Member Functions inherited from sc::Integral
 Integral (StateIn &)
 Restore the Integral object from the given StateIn object.
 
 Integral (const Ref< KeyVal > &)
 Construct the Integral object from the given KeyVal object.
 
virtual int equiv (const Ref< Integral > &)
 Returns nonzero if this and the given Integral object have the same integral ordering, normalization conventions, etc. More...
 
void set_storage (size_t i)
 Sets the total amount of storage, in bytes, that is available.
 
size_t storage_used ()
 Returns how much storage has been used.
 
size_t storage_unused ()
 Returns how much storage was not needed.
 
virtual size_t storage_required_eri (const Ref< GaussianBasisSet > &b1, const Ref< GaussianBasisSet > &b2=0, const Ref< GaussianBasisSet > &b3=0, const Ref< GaussianBasisSet > &b4=0)
 Returns how much storage will be needed to initialize a two-body integrals evaluator for electron repulsion integrals.
 
virtual size_t storage_required_grt (const Ref< GaussianBasisSet > &b1, const Ref< GaussianBasisSet > &b2=0, const Ref< GaussianBasisSet > &b3=0, const Ref< GaussianBasisSet > &b4=0)
 Returns how much storage will be needed to initialize a two-body integrals evaluator for linear R12 integrals.
 
virtual size_t storage_required_eri_deriv (const Ref< GaussianBasisSet > &b1, const Ref< GaussianBasisSet > &b2=0, const Ref< GaussianBasisSet > &b3=0, const Ref< GaussianBasisSet > &b4=0)
 Returns how much storage will be needed to initialize a two-body integrals evaluator for derivative electron repulsion integrals.
 
void adjust_storage (ptrdiff_t s)
 The specific integral classes use this to tell Integral how much memory they are using/freeing.
 
Ref< PetiteListpetite_list ()
 Return the PetiteList object.
 
Ref< PetiteListpetite_list (const Ref< GaussianBasisSet > &)
 Return the PetiteList object for the given basis set.
 
ShellRotation shell_rotation (int am, SymmetryOperation &, int pure=0)
 Return the ShellRotation object for a shell of the given angular momentum. More...
 
virtual Ref< OneBodyOneCenterIntpoint_charge1 (const Ref< PointChargeData > &)
 Return a OneBodyInt that computes the integrals for interactions with point charges.
 
virtual Ref< TwoBodyThreeCenterIntelectron_repulsion3 ()
 Return a TwoBodyThreeCenterInt that computes electron repulsion integrals. More...
 
virtual Ref< TwoBodyThreeCenterDerivIntelectron_repulsion3_deriv ()
 Return a TwoBodyThreeCenterInt that computes electron repulsion integrals. More...
 
virtual Ref< TwoBodyTwoCenterIntelectron_repulsion2 ()
 Return a TwoBodyTwoCenterInt that computes electron repulsion integrals. More...
 
virtual Ref< TwoBodyTwoCenterDerivIntelectron_repulsion2_deriv ()
 Return a TwoBodyTwoCenterInt that computes electron repulsion integrals. More...
 
virtual Ref< TwoBodyIntgrt ()
 Return a TwoBodyInt that computes two-electron integrals specific to linear R12 methods. More...
 
Ref< MessageGrpmessagegrp ()
 Return the MessageGrp used by the integrals objects.
 
- Public Member Functions inherited from sc::SavableState
SavableStateoperator= (const SavableState &)
 
void save_state (StateOut &)
 Save the state of the object as specified by the StateOut object. More...
 
void save_object_state (StateOut &)
 This can be used for saving state when the exact type of the object is known for both the save and the restore. More...
 
virtual void save_vbase_state (StateOut &)
 Save the virtual bases for the object. More...
 
- Public Member Functions inherited from sc::DescribedClass
 DescribedClass (const DescribedClass &)
 
DescribedClassoperator= (const DescribedClass &)
 
ClassDescclass_desc () const throw ()
 This returns the unique pointer to the ClassDesc corresponding to the given type_info object. More...
 
const char * class_name () const
 Return the name of the object's exact type.
 
int class_version () const
 Return the version of the class.
 
virtual void print (std::ostream &=ExEnv::out0()) const
 Print the object.
 
- Public Member Functions inherited from sc::RefCount
int lock_ptr () const
 Lock this object.
 
int unlock_ptr () const
 Unlock this object.
 
void use_locks (bool inVal)
 start and stop using locks on this object
 
refcount_t nreference () const
 Return the reference count.
 
refcount_t reference ()
 Increment the reference count and return the new count.
 
refcount_t dereference ()
 Decrement the reference count and return the new count.
 
int managed () const
 
void unmanage ()
 Turn off the reference counting mechanism for this object. More...
 
int managed () const
 Return 1 if the object is managed. Otherwise return 0.
 
- Public Member Functions inherited from sc::Identity
Identifier identifier ()
 Return the Identifier for this argument. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sc::Integral
static Integralinitial_integral (int &argc, char **argv)
 Create an integral factory. More...
 
static void set_default_integral (const Ref< Integral > &)
 Specifies a new default Integral factory.
 
static Integralget_default_integral ()
 Returns the default Integral factory.
 
- Static Public Member Functions inherited from sc::SavableState
static void save_state (SavableState *s, StateOut &)
 
static SavableStaterestore_state (StateIn &si)
 Restores objects saved with save_state. More...
 
static SavableStatekey_restore_state (StateIn &si, const char *keyword)
 Like restore_state, but keyword is used to override values while restoring.
 
static SavableStatedir_restore_state (StateIn &si, const char *objectname, const char *keyword=0)
 
- Protected Member Functions inherited from sc::Integral
 Integral (const Ref< GaussianBasisSet > &b1, const Ref< GaussianBasisSet > &b2, const Ref< GaussianBasisSet > &b3, const Ref< GaussianBasisSet > &b4)
 Initialize the Integral object given a GaussianBasisSet for each center.
 
- Protected Member Functions inherited from sc::SavableState
 SavableState (const SavableState &)
 
 SavableState (StateIn &)
 Each derived class StateIn CTOR handles the restore corresponding to calling save_object_state, save_vbase_state, and save_data_state listed above. More...
 
- Protected Member Functions inherited from sc::RefCount
 RefCount (const RefCount &)
 
RefCountoperator= (const RefCount &)
 
- Protected Attributes inherited from sc::Integral
Ref< GaussianBasisSetbs1_
 
Ref< GaussianBasisSetbs2_
 
Ref< GaussianBasisSetbs3_
 
Ref< GaussianBasisSetbs4_
 
size_t storage_
 
size_t storage_used_
 
Ref< MessageGrpgrp_
 

Detailed Description

IntegralCCA provides an SC client for CCA IntegralEvaluator components.

Constructor & Destructor Documentation

◆ IntegralCCA()

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

The KeyVal constructor.

This constructor is used when the framework is embedded. The following keywords are read:

evaluator_factory

This gives the symbol name of a CCA IntegralEvaluatorFactory component. This symbol name should also appear in the cca-load argument. The default is MPQC.IntegralEvaluatorFactory.

integral_package

If the default MPQC.IntegralEvaluatorFactory is used, then this option may be used to specify the integrals package to use (intv3 or cints). The default is intv3.

molecule
This gives a molecule object, it is required.

Member Function Documentation

◆ dipole()

Ref<OneBodyInt> sc::IntegralCCA::dipole ( const Ref< DipoleData > &  = 0)
virtual

Return a OneBodyInt that computes electric dipole moment integrals.

The canonical order of integrals in a set is x, y, z.

Implements sc::Integral.

◆ new_cartesian_iter()

CartesianIter* sc::IntegralCCA::new_cartesian_iter ( int  )
virtual

Return a CartesianIter object.

The caller is responsible for freeing the object.

Implements sc::Integral.

◆ new_redundant_cartesian_iter()

RedundantCartesianIter* sc::IntegralCCA::new_redundant_cartesian_iter ( int  )
virtual

Return a RedundantCartesianIter object.

The caller is responsible for freeing the object.

Implements sc::Integral.

◆ new_redundant_cartesian_sub_iter()

RedundantCartesianSubIter* sc::IntegralCCA::new_redundant_cartesian_sub_iter ( int  )
virtual

Return a RedundantCartesianSubIter object.

The caller is responsible for freeing the object.

Implements sc::Integral.

◆ new_spherical_transform_iter()

SphericalTransformIter* sc::IntegralCCA::new_spherical_transform_iter ( int  l,
int  inv = 0,
int  subl = -1 
)
virtual

Return a SphericalTransformIter object.

The caller is responsible for freeing the object.

Implements sc::Integral.

◆ nuclear()

Ref<OneBodyInt> sc::IntegralCCA::nuclear ( )
virtual

Return a OneBodyInt that computes the nuclear repulsion integrals.

Charges from the atoms on center one are used. If center two is not identical to center one, then the charges on center two are included as well.

Implements sc::Integral.

◆ quadrupole()

Ref<OneBodyInt> sc::IntegralCCA::quadrupole ( const Ref< DipoleData > &  = 0)
virtual

Return a OneBodyInt that computes electric quadrupole moment integrals.

The canonical order of integrals in a set is x^2, xy, xz, y^2, yz, z^2.

Implements sc::Integral.

◆ save_data_state()

void sc::IntegralCCA::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::Integral.

◆ spherical_transform()

const SphericalTransform* sc::IntegralCCA::spherical_transform ( int  l,
int  inv = 0,
int  subl = -1 
)
virtual

Return a SphericalTransform object.

The pointer is only valid while this Integral object is valid.

Implements sc::Integral.


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

Generated at Sun Jan 26 2020 23:33:06 for MPQC 2.3.1 using the documentation package Doxygen 1.8.16.