mirror of
https://github.com/QuantumPackage/qp2.git
synced 2024-11-16 02:53:51 +01:00
474 lines
9.8 KiB
ReStructuredText
474 lines
9.8 KiB
ReStructuredText
.. _module_kohn_sham_rs:
|
|
|
|
.. program:: kohn_sham_rs
|
|
|
|
.. default-role:: option
|
|
|
|
============
|
|
kohn_sham_rs
|
|
============
|
|
|
|
|
|
Quick description
|
|
-----------------
|
|
|
|
The Range-separated Kohn-Sham module performs *Restricted* range-separated Hybrid calculation,
|
|
which means that only the long-range part of the *exact* exchange is taken into account.
|
|
|
|
The program associated to it is the :ref:`rs_ks_scf` executable.
|
|
|
|
.. seealso::
|
|
|
|
The documentation of the :ref:`module_dft_keywords` module for the various keywords
|
|
such as the exchange/correlation functionals or the range-separation parameter.
|
|
|
|
|
|
.. seealso::
|
|
To see the keywords/options associated to the |SCF| algorithm itself,
|
|
see the documentation of the :ref:`module_scf_utils` module.
|
|
|
|
|
|
More advanced description
|
|
-------------------------
|
|
|
|
The splitting of the interaction between long- and short-range is determined by the range-separation parameter :option:`ao_two_e_erf_ints mu_erf`. The long-range part of the interaction is explicitly treated with exact exchange, and the short-range part of the interaction is treated with appropriate DFT functionals.
|
|
|
|
The Range-separated Kohn-Sham in an SCF and therefore is based on the :ref:`module_scf_utils` structure.
|
|
|
|
The definition of the Fock matrix is in :file:`kohn_sham_rs fock_matrix_rs_ks.irp.f`
|
|
|
|
|
|
.. seealso::
|
|
For a more detailed description of the |SCF| structure,
|
|
see the documentation of the :ref:`module_scf_utils` module.
|
|
|
|
|
|
|
|
|
|
|
|
EZFIO parameters
|
|
----------------
|
|
|
|
.. option:: energy
|
|
|
|
Energy range separated hybrid
|
|
|
|
|
|
|
|
Programs
|
|
--------
|
|
|
|
* :ref:`rs_ks_scf`
|
|
|
|
Providers
|
|
---------
|
|
|
|
.. c:var:: ao_potential_alpha_xc
|
|
|
|
|
|
File : :file:`pot_functionals.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision, allocatable :: ao_potential_alpha_xc (ao_num,ao_num)
|
|
double precision, allocatable :: ao_potential_beta_xc (ao_num,ao_num)
|
|
|
|
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`potential_c_alpha_ao`
|
|
* :c:data:`potential_x_alpha_ao`
|
|
* :c:data:`potential_xc_alpha_ao`
|
|
* :c:data:`same_xc_func`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`rs_ks_energy`
|
|
|
|
|
|
.. c:var:: ao_potential_beta_xc
|
|
|
|
|
|
File : :file:`pot_functionals.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision, allocatable :: ao_potential_alpha_xc (ao_num,ao_num)
|
|
double precision, allocatable :: ao_potential_beta_xc (ao_num,ao_num)
|
|
|
|
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`potential_c_alpha_ao`
|
|
* :c:data:`potential_x_alpha_ao`
|
|
* :c:data:`potential_xc_alpha_ao`
|
|
* :c:data:`same_xc_func`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`rs_ks_energy`
|
|
|
|
|
|
.. c:var:: e_correlation_dft
|
|
|
|
|
|
File : :file:`pot_functionals.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: e_correlation_dft
|
|
|
|
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`energy_c`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
* :c:data:`rs_ks_energy`
|
|
|
|
|
|
.. c:var:: e_exchange_dft
|
|
|
|
|
|
File : :file:`pot_functionals.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: e_exchange_dft
|
|
|
|
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`energy_x`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
* :c:data:`rs_ks_energy`
|
|
|
|
|
|
.. c:var:: fock_matrix_alpha_no_xc_ao
|
|
|
|
|
|
File : :file:`fock_matrix_rs_ks.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision, allocatable :: fock_matrix_alpha_no_xc_ao (ao_num,ao_num)
|
|
double precision, allocatable :: fock_matrix_beta_no_xc_ao (ao_num,ao_num)
|
|
|
|
|
|
Mono electronic an Coulomb matrix in ao basis set
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
|
|
|
|
.. c:var:: fock_matrix_beta_no_xc_ao
|
|
|
|
|
|
File : :file:`fock_matrix_rs_ks.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision, allocatable :: fock_matrix_alpha_no_xc_ao (ao_num,ao_num)
|
|
double precision, allocatable :: fock_matrix_beta_no_xc_ao (ao_num,ao_num)
|
|
|
|
|
|
Mono electronic an Coulomb matrix in ao basis set
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
|
|
|
|
.. c:var:: fock_matrix_energy
|
|
|
|
|
|
File : :file:`rs_ks_energy.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: rs_ks_energy
|
|
double precision :: two_e_energy
|
|
double precision :: one_e_energy
|
|
double precision :: fock_matrix_energy
|
|
double precision :: trace_potential_xc
|
|
|
|
|
|
Range-separated Kohn-Sham energy containing the nuclear repulsion energy, and the various components of this quantity.
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_potential_alpha_xc`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
* :c:data:`e_correlation_dft`
|
|
* :c:data:`e_exchange_dft`
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`nuclear_repulsion`
|
|
* :c:data:`scf_density_matrix_ao_alpha`
|
|
* :c:data:`scf_density_matrix_ao_beta`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
|
|
|
|
.. c:var:: one_e_energy
|
|
|
|
|
|
File : :file:`rs_ks_energy.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: rs_ks_energy
|
|
double precision :: two_e_energy
|
|
double precision :: one_e_energy
|
|
double precision :: fock_matrix_energy
|
|
double precision :: trace_potential_xc
|
|
|
|
|
|
Range-separated Kohn-Sham energy containing the nuclear repulsion energy, and the various components of this quantity.
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_potential_alpha_xc`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
* :c:data:`e_correlation_dft`
|
|
* :c:data:`e_exchange_dft`
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`nuclear_repulsion`
|
|
* :c:data:`scf_density_matrix_ao_alpha`
|
|
* :c:data:`scf_density_matrix_ao_beta`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
|
|
|
|
.. c:var:: rs_ks_energy
|
|
|
|
|
|
File : :file:`rs_ks_energy.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: rs_ks_energy
|
|
double precision :: two_e_energy
|
|
double precision :: one_e_energy
|
|
double precision :: fock_matrix_energy
|
|
double precision :: trace_potential_xc
|
|
|
|
|
|
Range-separated Kohn-Sham energy containing the nuclear repulsion energy, and the various components of this quantity.
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_potential_alpha_xc`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
* :c:data:`e_correlation_dft`
|
|
* :c:data:`e_exchange_dft`
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`nuclear_repulsion`
|
|
* :c:data:`scf_density_matrix_ao_alpha`
|
|
* :c:data:`scf_density_matrix_ao_beta`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
|
|
|
|
.. c:var:: trace_potential_xc
|
|
|
|
|
|
File : :file:`rs_ks_energy.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: rs_ks_energy
|
|
double precision :: two_e_energy
|
|
double precision :: one_e_energy
|
|
double precision :: fock_matrix_energy
|
|
double precision :: trace_potential_xc
|
|
|
|
|
|
Range-separated Kohn-Sham energy containing the nuclear repulsion energy, and the various components of this quantity.
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_potential_alpha_xc`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
* :c:data:`e_correlation_dft`
|
|
* :c:data:`e_exchange_dft`
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`nuclear_repulsion`
|
|
* :c:data:`scf_density_matrix_ao_alpha`
|
|
* :c:data:`scf_density_matrix_ao_beta`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
|
|
|
|
.. c:var:: two_e_energy
|
|
|
|
|
|
File : :file:`rs_ks_energy.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
double precision :: rs_ks_energy
|
|
double precision :: two_e_energy
|
|
double precision :: one_e_energy
|
|
double precision :: fock_matrix_energy
|
|
double precision :: trace_potential_xc
|
|
|
|
|
|
Range-separated Kohn-Sham energy containing the nuclear repulsion energy, and the various components of this quantity.
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`ao_num`
|
|
* :c:data:`ao_one_e_integrals`
|
|
* :c:data:`ao_potential_alpha_xc`
|
|
* :c:data:`ao_two_e_integral_alpha`
|
|
* :c:data:`e_correlation_dft`
|
|
* :c:data:`e_exchange_dft`
|
|
* :c:data:`fock_matrix_ao_alpha`
|
|
* :c:data:`nuclear_repulsion`
|
|
* :c:data:`scf_density_matrix_ao_alpha`
|
|
* :c:data:`scf_density_matrix_ao_beta`
|
|
|
|
Needed by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`extra_e_contrib_density`
|
|
|
|
|
|
|
|
Subroutines / functions
|
|
-----------------------
|
|
|
|
.. c:function:: check_coherence_functional:
|
|
|
|
|
|
File : :file:`rs_ks_scf.irp.f`
|
|
|
|
.. code:: fortran
|
|
|
|
subroutine check_coherence_functional
|
|
|
|
|
|
|
|
Needs:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:data:`correlation_functional`
|
|
* :c:data:`exchange_functional`
|
|
|
|
Called by:
|
|
|
|
.. hlist::
|
|
:columns: 3
|
|
|
|
* :c:func:`rs_ks_scf`
|
|
|