ergo
SCF_restricted Class Reference

#include <SCF_restricted.h>

Inheritance diagram for SCF_restricted:
SCF_general

Public Member Functions

 SCF_restricted (const Molecule &molecule_, const Molecule &extraCharges_, const BasisInfoStruct &basisInfo_, const IntegralInfo &integralInfo_, const char *guessDmatFileNamePtr, const JK::Params &J_K_paramsPtr, const Dft::GridParams &gridParams_, const SCF::Options &scfopts, const SCF::MatOptions &matOpts, ergo_real threshold_integrals_1el_input)
 
 ~SCF_restricted ()
 
void get_Fock_matrix (symmMatrix &FockMatrix_)
 
void get_density_matrix (symmMatrix &densityMatrix_)
 
- Public Member Functions inherited from SCF_general
void do_SCF_iterations ()
 
void get_overlap_matrix (symmMatrix &S)
 
void get_invCholFactor_matrix (triangMatrix &invCholFactor_)
 
void get_H_core_matrix (symmMatrix &H_core)
 
void get_energy (ergo_real &E, ergo_real &E_nuclear)
 

Private Member Functions

void initialize_matrices ()
 
void check_params ()
 
void get_starting_guess_density ()
 
void initialize_homo_lumo_limits ()
 
void write_matrices_to_file ()
 
void get_2e_part_and_energy ()
 
void output_sparsity_S_F_D (SCF_statistics &stats)
 
void calculate_energy ()
 
void get_FDSminusSDF ()
 
void get_error_measure ()
 
void add_to_DIIS_list ()
 
void update_best_fock_so_far ()
 
void combine_old_fock_matrices (ergo_real stepLength)
 
void use_diis_to_get_new_fock_matrix ()
 
void clear_diis_list ()
 
void clear_error_matrices ()
 
void save_current_fock_as_fprev ()
 
void get_new_density_matrix ()
 
void write_density_to_file ()
 
void save_final_potential ()
 
void add_random_disturbance_to_starting_guess ()
 
void output_expected_values_pos_operator ()
 
void get_expected_values_pos_operator (generalVector &eigVec, const char *vector_name)
 
void output_density_images ()
 
void output_density_images_orbital (generalVector &eigVec, const std::string &filename_id)
 
void write_diag_dens_to_file ()
 
void report_final_results ()
 
void save_density_as_prevdens ()
 
void update_subspace_diff ()
 
void disturb_fock_matrix (ergo_real subspaceError)
 
void disturb_dens_matrix (ergo_real subspaceError)
 
void do_spin_flip (int atomCount)
 
void disturb_dens_matrix_exact (ergo_real subspaceError)
 
void save_full_matrices_for_matlab ()
 
void report_density_difference ()
 
void create_mtx_files_F (int const scfIter)
 
void create_mtx_files_D (int const scfIter)
 
void create_homo_eigvec_file () const
 
void create_lumo_eigvec_file () const
 
void create_eigenvectors_files () const
 
void create_eigvec_file (const generalVector &eigVec, const char *vector_name, const char *filename_id) const
 
void create_gabedit_file () const
 
void create_gabedit_file_2 () const
 
void compute_dipole_moment ()
 
void do_mulliken_pop_stuff ()
 
void compute_gradient_fixeddens ()
 
void get_non_ort_err_mat_normalized_in_ort_basis (symmMatrix &randomMatrix, int transform_with_S_also)
 
void transform_with_S (symmMatrix &A)
 Transform matrix A to S*A*S. More...
 
void transform_with_invChol (symmMatrix &A)
 Transform matrix A to invCholT*A*invChol. More...
 
void disturb_dens_matrix_exact_try (const symmMatrix &randomMatrix, const symmMatrix &orgDensMatrix, ergo_real disturbanceFactor, ergo_real &resultSinTheta, symmMatrix &resultDensMatrix)
 

Private Attributes

symmMatrix densityMatrix
 
symmMatrix densityMatrix_core
 
symmMatrix twoel_matrix_core
 
symmMatrix FockMatrix
 
symmMatrix Fprev
 
symmMatrix Dprev
 
symmMatrix F_ort_prev
 
symmMatrix D_ort_prev
 
symmMatrix bestFockMatrixSoFar
 
symmMatrix bestFockMatrixSoFar2
 
normalMatrix ErrorMatrix
 
symmMatrix J_matrix
 
symmMatrix K_matrix
 
symmMatrix Fxc_matrix
 
generalVector eigVecLUMO
 
generalVector eigVecHOMO
 
intervalType homoInterval_F_ort_prev
 
intervalType lumoInterval_F_ort_prev
 
intervalType homoInterval_Fprev
 
intervalType lumoInterval_Fprev
 

Additional Inherited Members

- Protected Member Functions inherited from SCF_general
 SCF_general (const Molecule &molecule_, const Molecule &extraCharges_, const BasisInfoStruct &basisInfo_, const IntegralInfo &integralInfo_, const char *guessDmatFileName_, const JK::Params &J_K_params_, const Dft::GridParams &gridParams_, const SCF::Options &scfopts, const SCF::MatOptions &matOpts, ergo_real threshold_integrals_1el_input)
 
virtual ~SCF_general ()
 
ergo_real GetEuclideanNormOfMatrix (const symmMatrix &A)
 
- Protected Attributes inherited from SCF_general
const Moleculemolecule
 
const MoleculeextraCharges
 
const BasisInfoStructbasisInfo
 
const IntegralInfointegralInfo
 
const char * guessDmatFileName
 
const JK::ParamsJ_K_params
 
const Dft::GridParamsgridParams
 
const SCF::Optionsscfopts
 
const SCF::MatOptionsmatOpts
 
ergo_real threshold_integrals_1el
 
JK::ExchWeights CAM_params
 
int SCF_step
 
ergo_real nuclearEnergy
 
ergo_real energy_2el
 
ergo_real energy
 
ergo_real energy_2el_core
 
ergo_real energy_2el_valence
 
ergo_real energy_of_valence
 
ergo_real energy_reference
 
ergo_real electronicEntropyTerm
 
ergo_real errorMeasure
 
ergo_real curr_subspace_diff
 
symmMatrix S_symm
 
triangMatrix invCholFactor
 
ergo_real invCholFactor_euclnorm
 
symmMatrix H_core_Matrix
 
DIISManagerDIIS
 
int noOfElectrons
 
SCF_statisticscurr_cycle_stats
 
GetDensFromFock DensFromFock
 

Constructor & Destructor Documentation

◆ SCF_restricted()

SCF_restricted::SCF_restricted ( const Molecule molecule_,
const Molecule extraCharges_,
const BasisInfoStruct basisInfo_,
const IntegralInfo integralInfo_,
const char *  guessDmatFileNamePtr,
const JK::Params J_K_paramsPtr,
const Dft::GridParams gridParams_,
const SCF::Options scfopts,
const SCF::MatOptions matOpts,
ergo_real  threshold_integrals_1el_input 
)

◆ ~SCF_restricted()

SCF_restricted::~SCF_restricted ( )

References SCF_general::DIIS.

Member Function Documentation

◆ add_random_disturbance_to_starting_guess()

◆ add_to_DIIS_list()

void SCF_restricted::add_to_DIIS_list ( )
privatevirtual

◆ calculate_energy()

◆ check_params()

void SCF_restricted::check_params ( )
privatevirtual

◆ clear_diis_list()

void SCF_restricted::clear_diis_list ( )
privatevirtual

Implements SCF_general.

References SCF_general::DIIS.

◆ clear_error_matrices()

void SCF_restricted::clear_error_matrices ( )
privatevirtual

◆ combine_old_fock_matrices()

void SCF_restricted::combine_old_fock_matrices ( ergo_real  stepLength)
privatevirtual

◆ compute_dipole_moment()

◆ compute_gradient_fixeddens()

◆ create_eigenvectors_files()

void SCF_restricted::create_eigenvectors_files ( ) const
privatevirtual

Implements SCF_general.

References create_eigvec_file(), eigVecHOMO, and eigVecLUMO.

◆ create_eigvec_file()

◆ create_gabedit_file()

◆ create_gabedit_file_2()

void SCF_restricted::create_gabedit_file_2 ( ) const
private

◆ create_homo_eigvec_file()

void SCF_restricted::create_homo_eigvec_file ( ) const
private

◆ create_lumo_eigvec_file()

void SCF_restricted::create_lumo_eigvec_file ( ) const
private

◆ create_mtx_files_D()

◆ create_mtx_files_F()

◆ disturb_dens_matrix()

void SCF_restricted::disturb_dens_matrix ( ergo_real  subspaceError)
privatevirtual

◆ disturb_dens_matrix_exact()

◆ disturb_dens_matrix_exact_try()

◆ disturb_fock_matrix()

◆ do_mulliken_pop_stuff()

◆ do_spin_flip()

void SCF_restricted::do_spin_flip ( int  atomCount)
privatevirtual

Implements SCF_general.

◆ get_2e_part_and_energy()

void SCF_restricted::get_2e_part_and_energy ( )
privatevirtual

Implements SCF_general.

References SCF_statistics::add_value(), SCF_general::basisInfo, SCF_general::CAM_params, check_if_matrix_contains_strange_elements(), SCF::Options::compute_core_density, SCF_general::curr_cycle_stats, densityMatrix, densityMatrix_core, SCF::Options::do_acc_scan_J, do_acc_scan_J(), SCF::Options::do_acc_scan_K, do_acc_scan_K(), SCF::Options::do_acc_scan_Vxc, do_acc_scan_Vxc(), SCF::Options::do_f_thresh_verification, do_output(), SCF_general::energy_2el, SCF_general::energy_2el_core, SCF_general::energy_2el_valence, FockMatrix, Fprev, Fxc_matrix, SCF::Options::gap_expected_lower_bound, get_2e_matrix_and_energy_sparse(), get_eucl_diff_with_adapted_accuracy(), get_machine_epsilon(), SCF_general::gridParams, SCF_general::H_core_Matrix, homoInterval_Fprev, if(), mat::Interval< Treal >::increase(), SCF_general::integralInfo, SCF_general::invCholFactor, SCF::MatOptions::inversePermutationHML, SCF_general::J_K_params, J_matrix, K_matrix, LOG_AREA_DENSFROMF, LOG_AREA_SCF, LOG_CAT_ERROR, LOG_CAT_INFO, mat::Interval< Treal >::low(), lumoInterval_Fprev, SCF_general::matOpts, SCF_general::molecule, SCF::Options::no_of_core_electrons, BasisInfoStruct::noOfBasisFuncs, SCF_general::noOfElectrons, output_diff_norm_values(), SCF::MatOptions::permutationHML, Util::TimeMeter::print(), SCF::Options::purification_subspace_err_limit, SCF::Options::scan_do_invcholfactor_transf, SCF::Options::scan_no_of_steps, SCF::Options::scan_start_thresh, SCF::Options::scan_step_factor, SCF_general::scfopts, SCF::MatOptions::size_block_info, template_blas_sqrt(), mat::transpose(), twoel_matrix_core, mat::Interval< Treal >::upp(), and SCF::Options::use_dft.

◆ get_density_matrix()

void SCF_restricted::get_density_matrix ( symmMatrix densityMatrix_)

References densityMatrix.

◆ get_error_measure()

void SCF_restricted::get_error_measure ( )
privatevirtual

◆ get_expected_values_pos_operator()

◆ get_FDSminusSDF()

◆ get_Fock_matrix()

void SCF_restricted::get_Fock_matrix ( symmMatrix FockMatrix_)

References FockMatrix.

◆ get_new_density_matrix()

void SCF_restricted::get_new_density_matrix ( )
privatevirtual

Implements SCF_general.

References SCF_statistics::add_values(), SCF_general::basisInfo, SCF::Options::checkpoint_IDstr, GetDensFromFock::clean_eigs_intervals(), GetDensFromFock::clean_puri_stats(), SCF::Options::compute_core_density, GetDensFromFock::compute_eigenvectors(), GetDensFromFock::compute_eigenvectors_extra(), GetDensFromFock::create_checkpoint(), SCF::Options::create_checkpoints, SCF_general::curr_cycle_stats, SCF_general::DensFromFock, densityMatrix, densityMatrix_core, do_output(), SCF::Options::eigensolver_accuracy, SCF::Options::eigensolver_maxiter, SCF::Options::eigenvectors_iterative_method, SCF::Options::eigenvectors_method, eigVecHOMO, eigVecLUMO, SCF_general::electronicEntropyTerm, F_ort_prev, FockMatrix, GetDensFromFock::get_dens_from_fock(), GetDensFromFock::get_eigs_F_ort_prev(), GetDensFromFock::get_eigs_Fprev(), GetDensFromFock::get_output_homo_and_lumo_eigenvectors(), GetDensFromFock::get_puri_stats(), GetDensFromFock::get_result_entropy_term(), GetDensFromFock::get_use_purification(), homoInterval_F_ort_prev, homoInterval_Fprev, mat::VectorGeneral< Treal, Tvector >::is_empty(), LOG_AREA_SCF, LOG_CAT_INFO, lumoInterval_F_ort_prev, lumoInterval_Fprev, SCF::Options::min_number_of_iterations, BasisInfoStruct::noOfBasisFuncs, output_sparsity_symm(), Util::TimeMeter::print(), SCF::Options::puri_compute_eigv_in_each_iteration, SCF::Options::run_shift_and_square_method_on_F, SCF_general::S_symm, SCF_general::SCF_step, SCF_general::scfopts, GetDensFromFock::set_eigs_F_ort_prev(), GetDensFromFock::set_generate_figures(), GetDensFromFock::set_SCF_step(), SCF::Options::shift_using_prev_density_matrix, transform_with_S(), SCF::Options::try_eigv_on_next_iteration_if_fail, UNIT_one_eV, GetDensFromFock::unset_generate_figures(), and SCF::Options::use_prev_vector_as_initial_guess.

◆ get_non_ort_err_mat_normalized_in_ort_basis()

void SCF_restricted::get_non_ort_err_mat_normalized_in_ort_basis ( symmMatrix randomMatrix,
int  transform_with_S_also 
)
private

◆ get_starting_guess_density()

◆ initialize_homo_lumo_limits()

void SCF_restricted::initialize_homo_lumo_limits ( )
privatevirtual

◆ initialize_matrices()

◆ output_density_images()

◆ output_density_images_orbital()

◆ output_expected_values_pos_operator()

void SCF_restricted::output_expected_values_pos_operator ( )
privatevirtual

◆ output_sparsity_S_F_D()

void SCF_restricted::output_sparsity_S_F_D ( SCF_statistics stats)
privatevirtual

◆ report_density_difference()

◆ report_final_results()

void SCF_restricted::report_final_results ( )
privatevirtual

Implements SCF_general.

◆ save_current_fock_as_fprev()

void SCF_restricted::save_current_fock_as_fprev ( )
privatevirtual

Implements SCF_general.

References FockMatrix, and Fprev.

◆ save_density_as_prevdens()

void SCF_restricted::save_density_as_prevdens ( )
privatevirtual

Implements SCF_general.

References densityMatrix, and Dprev.

◆ save_final_potential()

◆ save_full_matrices_for_matlab()

◆ transform_with_invChol()

void SCF_restricted::transform_with_invChol ( symmMatrix A)
private

◆ transform_with_S()

void SCF_restricted::transform_with_S ( symmMatrix A)
private

◆ update_best_fock_so_far()

void SCF_restricted::update_best_fock_so_far ( )
privatevirtual

◆ update_subspace_diff()

◆ use_diis_to_get_new_fock_matrix()

void SCF_restricted::use_diis_to_get_new_fock_matrix ( )
privatevirtual

◆ write_density_to_file()

◆ write_diag_dens_to_file()

void SCF_restricted::write_diag_dens_to_file ( )
privatevirtual

◆ write_matrices_to_file()

void SCF_restricted::write_matrices_to_file ( )
privatevirtual

Member Data Documentation

◆ bestFockMatrixSoFar

symmMatrix SCF_restricted::bestFockMatrixSoFar
private

◆ bestFockMatrixSoFar2

symmMatrix SCF_restricted::bestFockMatrixSoFar2
private

◆ D_ort_prev

symmMatrix SCF_restricted::D_ort_prev
private

◆ densityMatrix

◆ densityMatrix_core

◆ Dprev

◆ eigVecHOMO

◆ eigVecLUMO

◆ ErrorMatrix

◆ F_ort_prev

symmMatrix SCF_restricted::F_ort_prev
private

◆ FockMatrix

◆ Fprev

◆ Fxc_matrix

symmMatrix SCF_restricted::Fxc_matrix
private

Referenced by get_2e_part_and_energy().

◆ homoInterval_F_ort_prev

intervalType SCF_restricted::homoInterval_F_ort_prev
private

◆ homoInterval_Fprev

intervalType SCF_restricted::homoInterval_Fprev
private

◆ J_matrix

symmMatrix SCF_restricted::J_matrix
private

Referenced by get_2e_part_and_energy().

◆ K_matrix

symmMatrix SCF_restricted::K_matrix
private

Referenced by get_2e_part_and_energy().

◆ lumoInterval_F_ort_prev

intervalType SCF_restricted::lumoInterval_F_ort_prev
private

◆ lumoInterval_Fprev

intervalType SCF_restricted::lumoInterval_Fprev
private

◆ twoel_matrix_core

symmMatrix SCF_restricted::twoel_matrix_core
private

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