.TH "sc::RadialAngularIntegrator" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*- .ad l .nh .SH NAME sc::RadialAngularIntegrator \- An implementation of an integrator using any combination of a \fBRadialIntegrator\fP and an \fBAngularIntegrator\fP\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBsc::DenIntegrator\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBRadialAngularIntegrator\fP (const \fBRef\fP< \fBKeyVal\fP > &)" .br .RI "Construct a \fBRadialAngularIntegrator\fP from \fBKeyVal\fP input\&. " .ti -1c .RI "\fBRadialAngularIntegrator\fP (\fBStateIn\fP &)" .br .ti -1c .RI "void \fBsave_data_state\fP (\fBStateOut\fP &)" .br .RI "Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. " .ti -1c .RI "void \fBintegrate\fP (const \fBRef\fP< \fBDenFunctional\fP > &, const \fBRefSymmSCMatrix\fP &densa=0, const \fBRefSymmSCMatrix\fP &densb=0, double *nuclear_gradient=0)" .br .RI "Performs the integration of the given functional using the given alpha and beta density matrices\&. " .ti -1c .RI "void \fBprint\fP (std::ostream &=\fBExEnv::out0\fP()) const" .br .RI "Print the object\&. " .ti -1c .RI "\fBAngularIntegrator\fP * \fBget_angular_grid\fP (double radius, double atomic_radius, int charge, int deriv_order)" .br .ti -1c .RI "\fBRadialIntegrator\fP * \fBget_radial_grid\fP (int charge, int deriv_order)" .br .ti -1c .RI "void \fBinit_default_grids\fP (void)" .br .ti -1c .RI "int \fBangular_grid_offset\fP (int i)" .br .ti -1c .RI "void \fBset_grids\fP (void)" .br .ti -1c .RI "int \fBget_atomic_row\fP (int i)" .br .ti -1c .RI "void \fBinit_parameters\fP (void)" .br .ti -1c .RI "void \fBinit_parameters\fP (const \fBRef\fP< \fBKeyVal\fP > &keyval)" .br .ti -1c .RI "void \fBinit_pruning_coefficients\fP (const \fBRef\fP< \fBKeyVal\fP > &keyval)" .br .ti -1c .RI "void \fBinit_pruning_coefficients\fP (void)" .br .ti -1c .RI "void \fBinit_alpha_coefficients\fP (void)" .br .ti -1c .RI "int \fBselect_dynamic_grid\fP (void)" .br .ti -1c .RI "\fBRef\fP< \fBIntegrationWeight\fP > \fBweight\fP ()" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBRef\fP< \fBIntegrationWeight\fP > \fBweight_\fP" .br .ti -1c .RI "\fBRef\fP< \fBRadialIntegrator\fP > \fBradial_user_\fP" .br .ti -1c .RI "\fBRef\fP< \fBAngularIntegrator\fP > \fBangular_user_\fP" .br .ti -1c .RI "\fBRef\fP< \fBAngularIntegrator\fP > *** \fBangular_grid_\fP" .br .ti -1c .RI "\fBRef\fP< \fBRadialIntegrator\fP > ** \fBradial_grid_\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP An implementation of an integrator using any combination of a \fBRadialIntegrator\fP and an \fBAngularIntegrator\fP\&. .SH "Constructor & Destructor Documentation" .PP .SS "sc::RadialAngularIntegrator::RadialAngularIntegrator (const \fBRef\fP< \fBKeyVal\fP > &)" .PP Construct a \fBRadialAngularIntegrator\fP from \fBKeyVal\fP input\&. The accepted keyword are listed below\&. The most important keyword is \fCgrid\fP\&. The \fCdynamic\fP and \fCprune_grid\fP options may be of occassional interest\&. .IP "\fB\fCgrid\fP\fP" 1c Specifies the fineness of the grid\&. Possible values are \fCxcoarse\fP, \fCcoarse\fP, \fCmedium\fP, \fCfine\fP, \fCxfine\fP, and \fCultrafine\fP, in order of increasing accuracy and cost\&. The default is \fCfine\fP\&. .PP .IP "\fB\fCdynamic\fP\fP" 1c This gives a boolean value that, if true, will cause the grids to start out coarse, and approach the requested \fCgrid\fP value as more accuracy is required, when the calculation is close to convergence\&. The default is true\&. .PP .IP "\fB\fCprune_grid\fP\fP" 1c This gives a boolean value that, if true, will cause more course angular grids to be used near nuclei\&. The default is true\&. When this is true, further control over pruning can be obtained with the \fCangular_points\fP and \fCalpha_coeffs\fP keywords\&. .PP .IP "\fB\fCradial\fP\fP" 1c Specifies the \fBRadialIntegrator\fP object\&. If this is given, then specifying the \fCgrid\fP and \fCdynamic\fP keywords will not affect the radial grid\&. The default is controlled by other options, but is always one of several \fBEulerMaclaurinRadialIntegrator\fP objects\&. .PP .IP "\fB\fCangular\fP\fP" 1c Specifies the \fBAngularIntegrator\fP object\&. If this is given, then specifying the \fCgrid\fP, \fCprune_grid\fP, and \fCdynamic\fP keywords will not affect the angular grid\&. The default is controlled by other options, but is always one of several \fBLebedevLaikovIntegrator\fP objects\&. .PP .IP "\fB\fCweight\fP\fP" 1c Specifies the \fBIntegrationWeight\fP object\&. The default is \fBBeckeIntegrationWeight\fP\&. .PP .PP .SH "Member Function Documentation" .PP .SS "void sc::RadialAngularIntegrator::integrate (const \fBRef\fP< \fBDenFunctional\fP > &, const \fBRefSymmSCMatrix\fP & densa = \fC0\fP, const \fBRefSymmSCMatrix\fP & densb = \fC0\fP, double * nuclear_grad = \fC0\fP)\fC [virtual]\fP" .PP Performs the integration of the given functional using the given alpha and beta density matrices\&. The nuclear derivative contribution is placed in nuclear_grad, if it is non-null\&. .PP Implements \fBsc::DenIntegrator\fP\&. .SS "void sc::RadialAngularIntegrator::save_data_state (\fBStateOut\fP &)\fC [virtual]\fP" .PP Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. This must be implemented by the derived class if the class has data\&. .PP Reimplemented from \fBsc::DenIntegrator\fP\&. .SH "Author" .PP Generated automatically by Doxygen for MPQC from the source code\&.