MPQC  3.0.0-alpha
clscf.h
1 //
2 // clscf.h --- definition of the closed shell SCF class
3 //
4 // Copyright (C) 1996 Limit Point Systems, Inc.
5 //
6 // Author: Edward Seidl <seidl@janed.com>
7 // Maintainer: LPS
8 //
9 // This file is part of the SC Toolkit.
10 //
11 // The SC Toolkit is free software; you can redistribute it and/or modify
12 // it under the terms of the GNU Library General Public License as published by
13 // the Free Software Foundation; either version 2, or (at your option)
14 // any later version.
15 //
16 // The SC Toolkit is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU Library General Public License for more details.
20 //
21 // You should have received a copy of the GNU Library General Public License
22 // along with the SC Toolkit; see the file COPYING.LIB. If not, write to
23 // the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 //
25 // The U.S. Government is granted a limited license as per AL 91-7.
26 //
27 
28 #ifndef _chemistry_qc_scf_clscf_h
29 #define _chemistry_qc_scf_clscf_h
30 
31 #include <chemistry/qc/scf/scf.h>
32 
33 namespace sc {
34 
35 // //////////////////////////////////////////////////////////////////////////
36 
39 class CLSCF: public SCF {
40  protected:
41  Ref<PointGroup> most_recent_pg_;
42  int user_occupations_;
43  int tndocc_;
44  int nirrep_;
45  int *initial_ndocc_;
46  int *ndocc_;
47 
48  ResultRefSymmSCMatrix cl_fock_;
49 
50  public:
51  CLSCF(StateIn&);
67  CLSCF(const Ref<KeyVal>&);
68  ~CLSCF();
69 
71 
72  void print(std::ostream&o=ExEnv::out0()) const;
73 
74  double occupation(int irrep, int vectornum);
75 
76  int n_fock_matrices() const;
81  RefSymmSCMatrix fock(int i);
84 
86 
87  void symmetry_changed();
88 
90  double magnetic_moment() const;
91 
92  protected:
93  // these are temporary data, so they should not be checkpointed
94  RefSymmSCMatrix cl_dens_;
95  RefSymmSCMatrix cl_dens_diff_;
96  RefSymmSCMatrix cl_gmat_;
97 
98  void set_occupations(const RefDiagSCMatrix& evals);
99 
100  // scf things
101  void init_vector();
102  void done_vector();
103  void reset_density();
104  double new_density();
105  double scf_energy();
106 
107  Ref<SCExtrapData> initial_extrap_data();
108  Ref<SCExtrapData> extrap_data();
109 
110  // gradient things
111  void init_gradient();
112  void done_gradient();
113 
114  RefSymmSCMatrix lagrangian();
115  RefSymmSCMatrix gradient_density();
116 
117  // hessian things
118  void init_hessian();
119  void done_hessian();
120 
121  // The Hartree-Fock derivatives
122  void two_body_deriv_hf(double*grad,double exchange_fraction);
123 };
124 
125 }
126 
127 #endif
128 
129 // Local Variables:
130 // mode: c++
131 // c-file-style: "ETS"
132 // End:
sc::SCF
The SCF class is the base for all classes that use a self-consistent field procedure to solve an effe...
Definition: scf.h:51
sc::CLSCF::print
void print(std::ostream &o=ExEnv::out0()) const
Print information about the object.
sc::RefSymmSCMatrix
The RefSymmSCMatrix class is a smart pointer to an SCSymmSCMatrix specialization.
Definition: matrix.h:265
sc::CLSCF::effective_fock
RefSymmSCMatrix effective_fock()
Returns closed-shell Fock matrix in MO basis (including XC contribution for KS DFT).
sc::Ref
A template class that maintains references counts.
Definition: ref.h:361
sc::CLSCF::symmetry_changed
void symmetry_changed()
Call this if you have changed the molecular symmetry of the molecule contained by this MolecularEnerg...
sc::RefDiagSCMatrix
The RefDiagSCMatrix class is a smart pointer to an DiagSCMatrix specialization.
Definition: matrix.h:389
sc::CLSCF::density
RefSymmSCMatrix density()
Returns the SO density.
sc::CLSCF::magnetic_moment
double magnetic_moment() const
returns 0
sc::AccResult< RefSymmSCMatrix >
sc::CLSCF
The CLSCF class is a base for classes implementing a self-consistent procedure for closed-shell molec...
Definition: clscf.h:39
sc::StateIn
Definition: statein.h:79
sc::CLSCF::save_data_state
void save_data_state(StateOut &)
Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR ...
sc::StateOut
Definition: stateout.h:71
sc::CLSCF::occupation
double occupation(int irrep, int vectornum)
Returns the occupation.
sc::ExEnv::out0
static std::ostream & out0()
Return an ostream that writes from node 0.
sc::CLSCF::fock
RefSymmSCMatrix fock(int i)
Returns closed-shell Fock matrix in AO basis (excluding XC contribution in KS DFT).
sc
Contains all MPQC code up to version 3.
Definition: mpqcin.h:14

Generated at Sun Jan 26 2020 23:23:59 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.8.16.