49#include "./base/base_uses.f90"
57 CHARACTER(len=*),
PARAMETER,
PRIVATE :: moduleN =
'qs_core_energies'
64 MODULE PROCEDURE calculate_ptrace_1, calculate_ptrace_gamma, calculate_ptrace_kp
85 SUBROUTINE calculate_ptrace_gamma(hmat, pmat, ecore, nspin, spinmat)
88 REAL(KIND=
dp),
INTENT(OUT) :: ecore
89 INTEGER,
INTENT(IN) :: nspin
90 LOGICAL,
INTENT(IN),
OPTIONAL :: spinmat
92 CHARACTER(len=*),
PARAMETER :: routineN =
'calculate_ptrace_gamma'
94 INTEGER :: handle, ispin
98 CALL timeset(routinen, handle)
101 IF (
PRESENT(spinmat)) lspin = spinmat
107 CALL dbcsr_dot(hmat(ispin)%matrix, pmat(ispin)%matrix, etr)
109 CALL dbcsr_dot(hmat(1)%matrix, pmat(ispin)%matrix, etr)
114 CALL timestop(handle)
116 END SUBROUTINE calculate_ptrace_gamma
131 SUBROUTINE calculate_ptrace_kp(hmat, pmat, ecore, nspin, spinmat)
133 TYPE(
dbcsr_p_type),
DIMENSION(:, :),
POINTER :: hmat, pmat
134 REAL(kind=
dp),
INTENT(OUT) :: ecore
135 INTEGER,
INTENT(IN) :: nspin
136 LOGICAL,
INTENT(IN),
OPTIONAL :: spinmat
138 CHARACTER(len=*),
PARAMETER :: routinen =
'calculate_ptrace_kp'
140 INTEGER :: handle, ic, ispin, j, nc
142 REAL(kind=
dp),
ALLOCATABLE :: traces(:)
146 CALL timeset(routinen, handle)
149 IF (
PRESENT(spinmat)) lspin = spinmat
152 ALLOCATE (h(nspin*nc), p(nspin*nc), traces(nspin*nc))
158 h(j)%matrix => hmat(ispin, ic)%matrix
160 h(j)%matrix => hmat(1, ic)%matrix
162 p(j)%matrix => pmat(ispin, ic)%matrix
169 DO j = 1,
SIZE(traces)
170 ecore = ecore + traces(j)
173 CALL timestop(handle)
175 END SUBROUTINE calculate_ptrace_kp
194 SUBROUTINE calculate_ptrace_1(h, p, ecore)
197 REAL(KIND=
dp),
INTENT(OUT) :: ecore
199 CHARACTER(len=*),
PARAMETER :: routineN =
'calculate_ptrace_1'
203 CALL timeset(routinen, handle)
208 CALL timestop(handle)
210 END SUBROUTINE calculate_ptrace_1
230 E_overlap_core, atecc)
233 LOGICAL,
INTENT(IN) :: calculate_forces
234 LOGICAL,
INTENT(IN),
OPTIONAL :: molecular
235 REAL(kind=
dp),
INTENT(OUT),
OPTIONAL :: e_overlap_core
236 REAL(kind=
dp),
DIMENSION(:),
OPTIONAL :: atecc
238 CHARACTER(len=*),
PARAMETER :: routinen =
'calculate_ecore_overlap'
240 INTEGER :: atom_a, atom_b, handle, iatom, ikind, &
241 jatom, jkind, natom, nkind
242 INTEGER,
ALLOCATABLE,
DIMENSION(:) :: atom_of_kind
243 LOGICAL :: atenergy, only_molecule, use_virial
244 REAL(kind=
dp) :: aab, dab, eab, ecore_overlap, f, fab, &
246 REAL(kind=
dp),
ALLOCATABLE,
DIMENSION(:) :: alpha, radius, zeff
247 REAL(kind=
dp),
DIMENSION(3) :: deab, rab
248 REAL(kind=
dp),
DIMENSION(3, 3) :: pv_loc
254 DIMENSION(:),
POINTER :: nl_iterator
260 TYPE(
qs_kind_type),
DIMENSION(:),
POINTER :: qs_kind_set
263 CALL timeset(routinen, handle)
265 NULLIFY (atomic_kind_set)
266 NULLIFY (qs_kind_set)
270 NULLIFY (particle_set)
274 only_molecule = .false.
275 IF (
PRESENT(molecular)) only_molecule = molecular
278 atomic_kind_set=atomic_kind_set, &
279 qs_kind_set=qs_kind_set, &
280 particle_set=particle_set, &
288 nkind =
SIZE(atomic_kind_set)
289 natom =
SIZE(particle_set)
291 use_virial = virial%pv_availability .AND. (.NOT. virial%pv_numer)
293 ALLOCATE (alpha(nkind), radius(nkind), zeff(nkind))
298 IF (calculate_forces)
THEN
303 IF (
ASSOCIATED(atprop))
THEN
304 IF (atprop%energy)
THEN
312 NULLIFY (cneo_potential)
313 CALL get_qs_kind(qs_kind_set(ikind), cneo_potential=cneo_potential)
314 IF (
ASSOCIATED(cneo_potential))
THEN
315 alpha(ikind) = 1.0_dp
316 radius(ikind) = 1.0_dp
320 alpha_core_charge=alpha(ikind), &
321 core_charge_radius=radius(ikind), &
326 ecore_overlap = 0.0_dp
331 CALL get_iterator_info(nl_iterator, ikind=ikind, jkind=jkind, iatom=iatom, jatom=jatom, r=rab)
332 zab = zeff(ikind)*zeff(jkind)
333 aab = alpha(ikind)*alpha(jkind)/(alpha(ikind) + alpha(jkind))
336 rab2 = rab(1)*rab(1) + rab(2)*rab(2) + rab(3)*rab(3)
337 IF (rab2 > 1.e-8_dp)
THEN
338 IF (ikind == jkind .AND. iatom == jatom)
THEN
344 eab = zab*erfc(rootaab*dab)/dab
345 ecore_overlap = ecore_overlap + f*eab
347 atprop%atecc(iatom) = atprop%atecc(iatom) + 0.5_dp*f*eab
348 atprop%atecc(jatom) = atprop%atecc(jatom) + 0.5_dp*f*eab
350 IF (
PRESENT(atecc))
THEN
351 atecc(iatom) = atecc(iatom) + 0.5_dp*f*eab
352 atecc(jatom) = atecc(jatom) + 0.5_dp*f*eab
354 IF (calculate_forces)
THEN
355 deab(:) = rab(:)*f*(eab + fab*exp(-aab*rab2))/rab2
356 atom_a = atom_of_kind(iatom)
357 atom_b = atom_of_kind(jatom)
358 force(ikind)%core_overlap(:, atom_a) = force(ikind)%core_overlap(:, atom_a) + deab(:)
359 force(jkind)%core_overlap(:, atom_b) = force(jkind)%core_overlap(:, atom_b) - deab(:)
368 DEALLOCATE (alpha, radius, zeff)
369 IF (calculate_forces)
THEN
370 DEALLOCATE (atom_of_kind)
372 IF (calculate_forces .AND. use_virial)
THEN
373 virial%pv_ecore_overlap = virial%pv_ecore_overlap + pv_loc
374 virial%pv_virial = virial%pv_virial + pv_loc
377 CALL group%sum(ecore_overlap)
379 energy%core_overlap = ecore_overlap
381 IF (
PRESENT(e_overlap_core))
THEN
382 e_overlap_core = energy%core_overlap
385 CALL timestop(handle)
400 REAL(kind=
dp),
INTENT(OUT),
OPTIONAL :: e_self_core
401 REAL(kind=
dp),
DIMENSION(:),
OPTIONAL :: atecc
403 CHARACTER(len=*),
PARAMETER :: routinen =
'calculate_ecore_self'
405 INTEGER :: handle, iatom, ikind, iparticle_local, &
406 natom, nparticle_local
407 REAL(kind=
dp) :: alpha_core_charge, ecore_self, es, zeff
414 TYPE(
qs_kind_type),
DIMENSION(:),
POINTER :: qs_kind_set
419 CALL timeset(routinen, handle)
421 CALL get_qs_env(qs_env=qs_env, atomic_kind_set=atomic_kind_set, &
422 qs_kind_set=qs_kind_set, energy=energy, atprop=atprop)
426 DO ikind = 1,
SIZE(atomic_kind_set)
428 NULLIFY (cneo_potential)
429 CALL get_qs_kind(qs_kind_set(ikind), cneo_potential=cneo_potential)
430 IF (
ASSOCIATED(cneo_potential)) cycle
432 CALL get_qs_kind(qs_kind_set(ikind), zeff=zeff, alpha_core_charge=alpha_core_charge)
433 ecore_self = ecore_self - real(natom,
dp)*zeff**2*sqrt(alpha_core_charge)
436 energy%core_self = ecore_self/sqrt(
twopi)
437 IF (
PRESENT(e_self_core))
THEN
438 e_self_core = energy%core_self
441 IF (
ASSOCIATED(atprop))
THEN
442 IF (atprop%energy)
THEN
444 CALL get_qs_env(qs_env=qs_env, particle_set=particle_set, &
445 local_particles=local_particles)
446 natom =
SIZE(particle_set)
449 DO ikind = 1,
SIZE(atomic_kind_set)
451 NULLIFY (cneo_potential)
452 CALL get_qs_kind(qs_kind_set(ikind), cneo_potential=cneo_potential)
453 IF (
ASSOCIATED(cneo_potential)) cycle
454 nparticle_local = local_particles%n_el(ikind)
455 CALL get_qs_kind(qs_kind_set(ikind), zeff=zeff, alpha_core_charge=alpha_core_charge)
456 es = zeff**2*sqrt(alpha_core_charge)/sqrt(
twopi)
457 DO iparticle_local = 1, nparticle_local
458 iatom = local_particles%list(ikind)%array(iparticle_local)
459 atprop%ateself(iatom) = atprop%ateself(iatom) - es
464 IF (
PRESENT(atecc))
THEN
466 CALL get_qs_env(qs_env=qs_env, particle_set=particle_set, &
467 local_particles=local_particles)
468 natom =
SIZE(particle_set)
469 DO ikind = 1,
SIZE(atomic_kind_set)
470 nparticle_local = local_particles%n_el(ikind)
471 CALL get_qs_kind(qs_kind_set(ikind), zeff=zeff, alpha_core_charge=alpha_core_charge)
472 es = zeff**2*sqrt(alpha_core_charge)/sqrt(
twopi)
473 DO iparticle_local = 1, nparticle_local
474 iatom = local_particles%list(ikind)%array(iparticle_local)
475 atecc(iatom) = atecc(iatom) - es
480 CALL timestop(handle)
495 REAL(kind=
dp),
INTENT(IN) :: alpha
496 REAL(kind=
dp),
DIMENSION(:) :: atecc
498 CHARACTER(len=*),
PARAMETER :: routinen =
'calculate_ecore_alpha'
500 INTEGER :: handle, iatom, ikind, jatom, jkind, &
502 INTEGER,
ALLOCATABLE,
DIMENSION(:) :: kind_of
503 REAL(kind=
dp) :: dab, eab, fab, rootaab, zab
504 REAL(kind=
dp),
ALLOCATABLE,
DIMENSION(:) :: zeff
505 REAL(kind=
dp),
DIMENSION(3) :: rab
509 TYPE(
qs_kind_type),
DIMENSION(:),
POINTER :: qs_kind_set
511 CALL timeset(routinen, handle)
515 atomic_kind_set=atomic_kind_set, &
516 qs_kind_set=qs_kind_set, &
517 particle_set=particle_set)
520 nkind =
SIZE(atomic_kind_set)
521 natom =
SIZE(particle_set)
522 ALLOCATE (zeff(nkind))
525 CALL get_qs_kind(qs_kind_set(ikind), zeff=zeff(ikind))
528 rootaab = sqrt(0.5_dp*alpha)
530 ikind = kind_of(iatom)
531 atecc(iatom) = atecc(iatom) - zeff(ikind)**2*sqrt(alpha/
twopi)
532 DO jatom = iatom + 1, natom
533 jkind = kind_of(jatom)
534 zab = zeff(ikind)*zeff(jkind)
536 rab = particle_set(iatom)%r - particle_set(jatom)%r
538 dab = sqrt(sum(rab(:)**2))
539 eab = zab*erfc(rootaab*dab)/dab
540 atecc(iatom) = atecc(iatom) + 0.5_dp*eab
541 atecc(jatom) = atecc(jatom) + 0.5_dp*eab
547 CALL timestop(handle)
Define the atomic kind types and their sub types.
subroutine, public get_atomic_kind_set(atomic_kind_set, atom_of_kind, kind_of, natom_of_kind, maxatom, natom, nshell, fist_potential_present, shell_present, shell_adiabatic, shell_check_distance, damping_present)
Get attributes of an atomic kind set.
subroutine, public get_atomic_kind(atomic_kind, fist_potential, element_symbol, name, mass, kind_number, natom, atom_list, rcov, rvdw, z, qeff, apol, cpol, mm_radius, shell, shell_active, damping)
Get attributes of an atomic kind.
Holds information on atomic properties.
subroutine, public atprop_array_init(atarray, natom)
...
Handles all functions related to the CELL.
subroutine, public dbcsr_get_info(matrix, nblkrows_total, nblkcols_total, nfullrows_total, nfullcols_total, nblkrows_local, nblkcols_local, nfullrows_local, nfullcols_local, my_prow, my_pcol, local_rows, local_cols, proc_row_dist, proc_col_dist, row_blk_size, col_blk_size, row_blk_offset, col_blk_offset, distribution, name, matrix_type, group)
...
subroutine, public dbcsr_dot(matrix_a, matrix_b, trace)
Computes the dot product of two matrices, also known as the trace of their matrix product.
subroutine, public dbcsr_dot_batch(matrix_a, matrix_b, trace, comm)
Evaluate several dot products in one OpenMP region; MPI reductions remain outside it.
stores a lists of integer that are local to a processor. The idea is that these integers represent ob...
Defines the basic variable types.
integer, parameter, public dp
Definition of mathematical constants and functions.
real(kind=dp), parameter, public oorootpi
real(kind=dp), parameter, public twopi
Interface to the message passing library MPI.
Define the data structure for the particle information.
Types used by CNEO-DFT (see J. Chem. Theory Comput. 2025, 21, 16, 7865–7877).
Calculation of the energies concerning the core charge distribution.
subroutine, public calculate_ecore_overlap(qs_env, para_env, calculate_forces, molecular, e_overlap_core, atecc)
Calculate the overlap energy of the core charge distribution.
subroutine, public calculate_ecore_self(qs_env, e_self_core, atecc)
Calculate the self energy of the core charge distribution.
subroutine, public calculate_ecore_alpha(qs_env, alpha, atecc)
Calculate the overlap and self energy of the core charge distribution for a given alpha Use a minimum...
subroutine, public get_qs_env(qs_env, atomic_kind_set, qs_kind_set, cell, super_cell, cell_ref, use_ref_cell, kpoints, dft_control, mos, sab_orb, sab_all, qmmm, qmmm_periodic, mimic, sac_ae, sac_ppl, sac_lri, sap_ppnl, sab_vdw, sab_scp, sap_oce, sab_lrc, sab_se, sab_xtbe, sab_tbe, sab_core, sab_xb, sab_xtb_pp, sab_xtb_nonbond, sab_almo, sab_kp, sab_kp_nosym, sab_cneo, particle_set, energy, force, matrix_h, matrix_h_im, matrix_ks, matrix_ks_im, matrix_vxc, run_rtp, rtp, matrix_h_kp, matrix_h_im_kp, matrix_ks_kp, matrix_ks_im_kp, matrix_vxc_kp, kinetic_kp, matrix_s_kp, matrix_w_kp, matrix_s_ri_aux_kp, matrix_s, matrix_s_ri_aux, matrix_w, matrix_p_mp2, matrix_p_mp2_admm, matrix_vhxc, rho, rho_xc, pw_env, ewald_env, ewald_pw, active_space, mpools, input, para_env, blacs_env, scf_control, rel_control, kinetic, qs_charges, vppl, xcint_weights, rho_core, rho_nlcc, rho_nlcc_g, ks_env, ks_qmmm_env, wf_history, scf_env, local_particles, local_molecules, distribution_2d, dbcsr_dist, molecule_kind_set, molecule_set, subsys, cp_subsys, oce, local_rho_set, rho_atom_set, task_list, task_list_soft, rho0_atom_set, rho0_mpole, rhoz_set, rhoz_cneo_set, ecoul_1c, rho0_s_rs, rho0_s_gs, rhoz_cneo_s_rs, rhoz_cneo_s_gs, do_kpoints, has_unit_metric, requires_mo_derivs, mo_derivs, mo_loc_history, nkind, natom, nelectron_total, nelectron_spin, efield, neighbor_list_id, linres_control, xas_env, virial, cp_ddapc_env, cp_ddapc_ewald, outer_scf_history, outer_scf_ihistory, x_data, et_coupling, dftb_potential, results, se_taper, se_store_int_env, se_nddo_mpole, se_nonbond_env, admm_env, lri_env, lri_density, exstate_env, ec_env, harris_env, dispersion_env, gcp_env, vee, rho_external, external_vxc, mask, mp2_env, bs_env, kg_env, wanniercentres, atprop, ls_scf_env, do_transport, transport_env, v_hartree_rspace, s_mstruct_changed, rho_changed, potential_changed, forces_up_to_date, mscfg_env, almo_scf_env, gradient_history, variable_history, embed_pot, spin_embed_pot, polar_env, mos_last_converged, eeq, rhs, do_rixs, tb_tblite)
Get the QUICKSTEP environment.
Define the quickstep kind type and their sub types.
subroutine, public get_qs_kind(qs_kind, basis_set, basis_type, ncgf, nsgf, all_potential, tnadd_potential, gth_potential, sgp_potential, upf_potential, cneo_potential, se_parameter, dftb_parameter, xtb_parameter, dftb3_param, zatom, zeff, elec_conf, mao, lmax_dftb, alpha_core_charge, ccore_charge, core_charge, core_charge_radius, paw_proj_set, paw_atom, hard_radius, hard0_radius, max_rad_local, covalent_radius, vdw_radius, gpw_type_forced, harmonics, max_iso_not0, max_s_harm, grid_atom, ngrid_ang, ngrid_rad, lmax_rho0, dft_plus_u_atom, l_of_dft_plus_u, n_of_dft_plus_u, u_minus_j, hund_j, u_of_dft_plus_u, j_of_dft_plus_u, alpha_of_dft_plus_u, beta_of_dft_plus_u, j0_of_dft_plus_u, occupation_of_dft_plus_u, dispersion, bs_occupation, magnetization, no_optimize, addel, laddel, naddel, orbitals, max_scf, eps_scf, smear, u_ramping, u_minus_j_target, eps_u_ramping, proj_shell_charge, lr_atom, do_mtlr, u_j_loop, ao_coef, init_u_ramping_each_scf, reltmat, ghost, monovalent, floating, name, element_symbol, pao_basis_size, pao_model_file, pao_potentials, pao_descriptors, nelec)
Get attributes of an atomic kind.
Define the neighbor list data types and the corresponding functionality.
subroutine, public neighbor_list_iterator_create(iterator_set, nl, search, nthread)
Neighbor list iterator functions.
subroutine, public neighbor_list_iterator_release(iterator_set)
...
integer function, public neighbor_list_iterate(iterator_set, mepos)
...
subroutine, public get_iterator_info(iterator_set, mepos, ikind, jkind, nkind, ilist, nlist, inode, nnode, iatom, jatom, r, cell)
...
pure subroutine, public virial_pair_force(pv_virial, f0, force, rab)
Computes the contribution to the stress tensor from two-body pair-wise forces.
Provides all information about an atomic kind.
type for the atomic properties
Type defining parameters related to the simulation cell.
structure to store local (to a processor) ordered lists of integers.
stores all the informations relevant to an mpi environment
Provides all information about a quickstep kind.