2018-11-20 11:33:07 +01:00
.. _hartree_fock:
.. program :: hartree_fock
.. default-role :: option
============
Hartree-Fock
============
The Hartree-Fock module performs *Restricted* Hartree-Fock calculations (the
spatial part of the |MOs| is common for alpha and beta spinorbitals).
2018-12-25 18:59:11 +01:00
The Hartree-Fock in an SCF and therefore is based on the `` scf_utils `` structure.
It performs the following actions:
2018-11-20 11:33:07 +01:00
#. Compute/Read all the one- and two-electron integrals, and store them in memory
#. Check in the |EZFIO| database if there is a set of |MOs|. If there is, it
will read them as initial guess. Otherwise, it will create a guess.
#. Perform the |SCF| iterations
2018-12-25 18:59:11 +01:00
The definition of the Fock matrix is in :file: `hartree_fock fock_matrix_hf.irp.f`
For the keywords related to the |SCF| procedure, see the `` scf_utils `` directory where you will find all options.
The main are:
# :option: `scf_utils thresh_scf`
# :option: `scf_utils level_shift`
2018-11-20 11:33:07 +01:00
At each iteration, the |MOs| are saved in the |EZFIO| database. Hence, if the calculation
crashes for any unexpected reason, the calculation can be restarted by running again
the |SCF| with the same |EZFIO| database.
The `DIIS`_ algorithm is implemented, as well as the `level-shifting`_ method.
If the |SCF| does not converge, try again with a higher value of :option: `level_shift` .
To start a calculation from scratch, the simplest way is to remove the
`` mo_basis `` directory from the |EZFIO| database, and run the |SCF| again.
.. _DIIS: https://en.wikipedia.org/w/index.php?title=DIIS
.. _level-shifting: https://doi.org/10.1002/qua.560070407
EZFIO parameters
----------------
.. option :: energy
2018-12-25 18:59:11 +01:00
Energy HF
2018-11-20 11:33:07 +01:00
2018-12-25 18:59:11 +01:00
Default: 0.
2018-11-25 14:59:02 +01:00
Providers
---------
2018-11-26 13:45:32 +01:00
.. c:var :: ao_bi_elec_integral_alpha
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
double precision, allocatable :: ao_bi_elec_integral_alpha (ao_num,ao_num)
double precision, allocatable :: ao_bi_elec_integral_beta (ao_num,ao_num)
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `fock_matrix_hf.irp.f`
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
Alpha Fock matrix in AO basis set
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
.. c:var :: ao_bi_elec_integral_beta
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
double precision, allocatable :: ao_bi_elec_integral_alpha (ao_num,ao_num)
double precision, allocatable :: ao_bi_elec_integral_beta (ao_num,ao_num)
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `fock_matrix_hf.irp.f`
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
Alpha Fock matrix in AO basis set
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
.. c:var :: extra_e_contrib_density
2018-11-26 13:45:32 +01:00
.. code :: text
2018-12-25 18:59:11 +01:00
double precision :: extra_e_contrib_density
2018-11-26 13:45:32 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `hf_energy.irp.f`
2018-11-26 13:45:32 +01:00
2018-12-25 18:59:11 +01:00
Extra contribution to the SCF energy coming from the density.
For a Hartree-Fock calculation: extra_e_contrib_density = 0
For a Kohn-Sham or Range-separated Kohn-Sham: the exchange/correlation - trace of the V_xc potential
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
.. c:var :: fock_matrix_ao_alpha
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
double precision, allocatable :: fock_matrix_ao_alpha (ao_num,ao_num)
double precision, allocatable :: fock_matrix_ao_beta (ao_num,ao_num)
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `fock_matrix_hf.irp.f`
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
Alpha Fock matrix in AO basis set
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
.. c:var :: fock_matrix_ao_beta
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
double precision, allocatable :: fock_matrix_ao_alpha (ao_num,ao_num)
double precision, allocatable :: fock_matrix_ao_beta (ao_num,ao_num)
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `fock_matrix_hf.irp.f`
2018-11-25 14:59:02 +01:00
Alpha Fock matrix in AO basis set
2018-12-25 18:59:11 +01:00
.. c:var :: hf_energy
2018-11-25 14:59:02 +01:00
.. code :: text
2018-12-25 18:59:11 +01:00
double precision :: hf_energy
double precision :: hf_two_electron_energy
double precision :: hf_one_electron_energy
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `hf_energy.irp.f`
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
Hartree-Fock energy containing the nuclear repulsion, and its one- and two-body components.
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
.. c:var :: hf_one_electron_energy
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
double precision :: hf_energy
2018-12-25 18:59:11 +01:00
double precision :: hf_two_electron_energy
double precision :: hf_one_electron_energy
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `hf_energy.irp.f`
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
Hartree-Fock energy containing the nuclear repulsion, and its one- and two-body components.
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
.. c:var :: hf_two_electron_energy
2018-11-25 14:59:02 +01:00
.. code :: text
2018-12-25 18:59:11 +01:00
double precision :: hf_energy
double precision :: hf_two_electron_energy
double precision :: hf_one_electron_energy
2018-11-26 13:45:32 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `hf_energy.irp.f`
2018-11-26 13:45:32 +01:00
2018-12-25 18:59:11 +01:00
Hartree-Fock energy containing the nuclear repulsion, and its one- and two-body components.
2018-11-26 13:45:32 +01:00
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
Subroutines / functions
-----------------------
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
.. c:function :: create_guess
2018-11-25 14:59:02 +01:00
.. code :: text
2018-11-26 13:45:32 +01:00
subroutine create_guess
2018-11-25 14:59:02 +01:00
2018-12-25 18:59:11 +01:00
File: :file: `scf_old.irp.f`
2018-11-26 13:45:32 +01:00
Create a MO guess if no MOs are present in the EZFIO directory
2018-11-25 14:59:02 +01:00
2018-11-26 13:45:32 +01:00
.. c:function :: run
.. code :: text
subroutine run
2018-12-25 18:59:11 +01:00
File: :file: `scf_old.irp.f`
2018-11-26 13:45:32 +01:00
Run SCF calculation
.. c:function :: scf
.. code :: text
subroutine scf
2018-12-25 18:59:11 +01:00
File: :file: `scf_old.irp.f`
2018-11-26 13:45:32 +01:00
Produce `Hartree_Fock` MO orbital output: mo_basis.mo_tot_num mo_basis.mo_label mo_basis.ao_md5 mo_basis.mo_coef mo_basis.mo_occ output: hartree_fock.energy optional: mo_basis.mo_coef
2018-11-25 14:59:02 +01:00