51#include "./base/base_uses.f90"
57 CHARACTER(len=*),
PARAMETER,
PRIVATE :: moduleN =
'scf_control_types'
58 LOGICAL,
PRIVATE,
PARAMETER :: debug_this_module = .true.
93 LOGICAL :: do_smear = .false.
94 LOGICAL :: common_mu = .false.
95 INTEGER :: method = -1
96 REAL(kind=
dp) :: electronic_temperature = -1.0_dp, &
97 fixed_mag_mom = -1.0_dp, &
98 eps_fermi_dirac = -1.0_dp, &
99 window_size = -1.0_dp, &
100 smearing_width = -1.0_dp
101 REAL(kind=
dp),
DIMENSION(:),
POINTER ::
list => null()
104 TYPE diagonalization_type
105 INTEGER :: method = -1
106 REAL(kind=
dp) :: eps_jacobi = -1.0_dp
107 REAL(kind=
dp) :: jacobi_threshold = -1.0_dp
108 INTEGER :: max_iter = -1, nkrylov = -1, nblock_krylov = -1
110 LOGICAL :: mom = .false., mom_didguess = .false.
111 INTEGER :: mom_proj_formula = -1
113 INTEGER,
DIMENSION(:),
POINTER :: mom_deocca => null(), mom_deoccb => null(), &
114 mom_occa => null(), mom_occb => null()
119 INTEGER :: mom_start = -1
120 INTEGER :: mom_type = -1
121 REAL(kind=
dp) :: eps_iter = -1.0_dp
122 REAL(kind=
dp) :: eps_adapt = -1.0_dp
124 END TYPE diagonalization_type
129 TYPE(diagonalization_type) :: diagonalization = diagonalization_type()
131 INTEGER :: density_guess = -1, mixing_method = -1
132 REAL(kind=
dp) :: eps_eigval = -1.0_dp, eps_scf = -1.0_dp, eps_scf_hist = -1.0_dp, &
133 level_shift = -1.0_dp, &
134 eps_lumos = -1.0_dp, eps_diis = -1.0_dp
135 INTEGER :: max_iter_lumos = -1, max_diis = -1, nmixing = -1
136 INTEGER :: max_scf = -1, max_scf_hist = -1, &
137 maxl = -1, nkind = -1
138 LOGICAL :: do_diag_sub = .false., &
139 use_cholesky = .false., use_ot = .false., &
140 use_diag = .false., do_outer_scf_reortho = .false., &
141 ignore_convergence_failure = .false.
142 LOGICAL :: force_scf_calculation = .false.
143 LOGICAL :: non_selfconsistent = .false.
144 INTEGER,
DIMENSION(2) :: added_mos = -1
145 INTEGER :: roks_scheme = -1
146 REAL(kind=
dp) :: roks_f = -1.0_dp
147 REAL(kind=
dp),
DIMENSION(0:2, 0:2, 1:2) :: roks_parameter = -1.0_dp
151 LOGICAL :: do_gce = .false.
152 REAL(kind=
dp) :: target_workfunction = 0.16_dp, &
154 mixing_coef = 0.3_dp, &
155 prev_workfunction = -1001.0_dp, &
173 CHARACTER(LEN=*),
PARAMETER :: routinen =
'scf_c_create'
177 CALL timeset(routinen, handle)
181 IF (scf_control%non_selfconsistent)
THEN
182 scf_control%density_guess =
no_guess
186 scf_control%eps_eigval = 1.0e-5_dp
187 scf_control%eps_scf = 1.0e-5_dp
188 scf_control%eps_scf_hist = 0.0_dp
189 scf_control%eps_lumos = 1.0e-5_dp
190 scf_control%max_iter_lumos = 2999
191 scf_control%eps_diis = 0.1_dp
192 scf_control%level_shift = 0.0_dp
193 scf_control%max_diis = 4
194 scf_control%max_scf = 50
195 scf_control%nmixing = 2
196 scf_control%use_cholesky = .true.
197 scf_control%use_diag = .true.
198 scf_control%do_diag_sub = .false.
199 scf_control%use_ot = .false.
200 scf_control%ignore_convergence_failure = .false.
201 scf_control%force_scf_calculation = .false.
202 scf_control%do_outer_scf_reortho = .true.
203 scf_control%max_diis = 4
204 scf_control%eps_diis = 0.1_dp
205 scf_control%added_mos(:) = 0
206 scf_control%max_scf_hist = 0
209 IF (scf_control%non_selfconsistent)
THEN
210 scf_control%mixing_method =
no_mix
216 scf_control%diagonalization%method = 0
217 scf_control%diagonalization%eps_jacobi = 0.0_dp
218 scf_control%diagonalization%jacobi_threshold = 1.0e-7_dp
219 scf_control%diagonalization%max_iter = 0
220 scf_control%diagonalization%eps_iter = 0.0_dp
221 scf_control%diagonalization%eps_adapt = 0.0_dp
222 scf_control%diagonalization%nkrylov = 0
223 scf_control%diagonalization%nblock_krylov = 0
226 scf_control%diagonalization%mom = .false.
227 scf_control%diagonalization%mom_didguess = .false.
228 scf_control%diagonalization%mom_proj_formula = 0
229 NULLIFY (scf_control%diagonalization%mom_deoccA)
230 NULLIFY (scf_control%diagonalization%mom_deoccB)
231 NULLIFY (scf_control%diagonalization%mom_occA)
232 NULLIFY (scf_control%diagonalization%mom_occB)
233 scf_control%diagonalization%mom_start = 0
238 scf_control%roks_f = 0.5_dp
243 scf_control%roks_parameter(0, 0, 1) = 1.5_dp
244 scf_control%roks_parameter(0, 0, 2) = -0.5_dp
245 scf_control%roks_parameter(1, 1, 1) = 0.5_dp
246 scf_control%roks_parameter(1, 1, 2) = 0.5_dp
247 scf_control%roks_parameter(2, 2, 1) = -0.5_dp
248 scf_control%roks_parameter(2, 2, 2) = 1.5_dp
252 scf_control%roks_parameter(0, 1, 1) = 1.0_dp
253 scf_control%roks_parameter(0, 1, 2) = 0.0_dp
254 scf_control%roks_parameter(0, 2, 1) = 0.5_dp
255 scf_control%roks_parameter(0, 2, 2) = 0.5_dp
256 scf_control%roks_parameter(1, 2, 1) = 0.0_dp
257 scf_control%roks_parameter(1, 2, 2) = 1.0_dp
261 scf_control%roks_parameter(1, 0, 1) = scf_control%roks_parameter(0, 1, 1)
262 scf_control%roks_parameter(1, 0, 2) = scf_control%roks_parameter(0, 1, 2)
263 scf_control%roks_parameter(2, 0, 1) = scf_control%roks_parameter(0, 2, 1)
264 scf_control%roks_parameter(2, 0, 2) = scf_control%roks_parameter(0, 2, 2)
265 scf_control%roks_parameter(2, 1, 1) = scf_control%roks_parameter(1, 2, 1)
266 scf_control%roks_parameter(2, 1, 2) = scf_control%roks_parameter(1, 2, 2)
270 scf_control%outer_scf%have_scf = .false.
271 scf_control%outer_scf%max_scf = 0
272 scf_control%outer_scf%eps_scf = 0.0_dp
273 scf_control%outer_scf%step_size = 0.0_dp
274 scf_control%outer_scf%type = -1
275 scf_control%outer_scf%optimizer = -1
276 scf_control%outer_scf%diis_buffer_length = -1
277 NULLIFY (scf_control%outer_scf%cdft_opt_control)
281 NULLIFY (scf_control%smear)
283 CALL timestop(handle)
300 IF (
ASSOCIATED(scf_control%smear%list))
THEN
301 DEALLOCATE (scf_control%smear%list)
303 DEALLOCATE (scf_control%smear)
305 IF (
ASSOCIATED(scf_control%outer_scf%cdft_opt_control))
THEN
309 IF (
ASSOCIATED(scf_control%gce))
THEN
310 DEALLOCATE (scf_control%gce)
334 CHARACTER(LEN=*),
PARAMETER :: routinen =
'scf_c_read_parameters'
336 INTEGER :: cholesky_flag, handle, ialgo
337 INTEGER,
DIMENSION(:),
POINTER :: added_mos
338 LOGICAL :: do_mixing, explicit
339 REAL(kind=
dp),
DIMENSION(:),
POINTER :: roks_parameter
341 outer_scf_section, scf_section, &
344 CALL timeset(routinen, handle)
348 l_val=scf_control%use_diag)
349 IF (scf_control%use_diag)
THEN
351 l_val=scf_control%do_diag_sub)
354 IF (scf_control%use_diag .AND. scf_control%use_ot)
THEN
356 cpabort(
"Don't activate OT and Diagonaliztion together")
357 ELSE IF (.NOT. (scf_control%use_diag .OR. scf_control%use_ot))
THEN
359 scf_control%use_diag = .true.
366 IF (scf_control%use_ot)
THEN
368 scf_control%eps_diis = 0.0_dp
376 IF (cholesky_flag > 0)
THEN
377 scf_control%use_cholesky = .true.
379 CALL section_vals_val_get(scf_section,
"IGNORE_CONVERGENCE_FAILURE", l_val=scf_control%ignore_convergence_failure)
380 CALL section_vals_val_get(scf_section,
"FORCE_SCF_CALCULATION", l_val=scf_control%force_scf_calculation)
387 IF (scf_control%use_diag)
THEN
389 i_val=scf_control%diagonalization%method)
391 r_val=scf_control%diagonalization%eps_jacobi)
393 r_val=scf_control%diagonalization%jacobi_threshold)
395 i_val=scf_control%diagonalization%max_iter)
397 r_val=scf_control%diagonalization%eps_iter)
399 r_val=scf_control%diagonalization%eps_adapt)
401 i_val=scf_control%diagonalization%nkrylov)
403 i_val=scf_control%diagonalization%nblock_krylov)
404 IF (scf_control%diagonalization%method ==
diag_ot)
THEN
406 CALL ot_diag_read_input(scf_control%diagonalization%ot_settings, scf_section)
410 l_val=scf_control%diagonalization%MOM)
411 IF (scf_control%diagonalization%mom)
THEN
413 i_val=scf_control%diagonalization%mom_type)
416 i_val=scf_control%diagonalization%mom_start)
419 i_vals=scf_control%diagonalization%mom_deoccA)
422 i_vals=scf_control%diagonalization%mom_deoccB)
425 i_vals=scf_control%diagonalization%mom_occA)
428 i_vals=scf_control%diagonalization%mom_occB)
431 i_val=scf_control%diagonalization%mom_proj_formula)
438 SELECT CASE (scf_control%roks_scheme)
445 NULLIFY (roks_parameter)
447 IF (
ASSOCIATED(roks_parameter))
THEN
448 scf_control%roks_parameter(2, 2, 1) = roks_parameter(1)
449 scf_control%roks_parameter(2, 2, 2) = roks_parameter(2)
450 scf_control%roks_parameter(1, 1, 1) = roks_parameter(3)
451 scf_control%roks_parameter(1, 1, 2) = roks_parameter(4)
452 scf_control%roks_parameter(0, 0, 1) = roks_parameter(5)
453 scf_control%roks_parameter(0, 0, 2) = roks_parameter(6)
463 cpassert(
ASSOCIATED(added_mos))
464 IF (
SIZE(added_mos) > 0)
THEN
465 scf_control%added_mos(1) = added_mos(1)
466 IF (
SIZE(added_mos) > 1)
THEN
467 scf_control%added_mos(2) = added_mos(2)
474 IF (scf_control%level_shift /= 0.0_dp) scf_control%use_cholesky = .false.
481 CALL init_smear(scf_control%smear)
482 CALL read_smear_section(scf_control%smear, smear_section)
490 i_val=scf_control%mixing_method)
495 CALL init_gce(scf_control%gce)
496 CALL read_gce_section(scf_control%gce, gce_section)
498 CALL timestop(handle)
506 SUBROUTINE init_smear(smear)
509 cpassert(.NOT.
ASSOCIATED(smear))
511 smear%do_smear = .false.
513 smear%electronic_temperature = 0.0_dp
514 smear%eps_fermi_dirac = 1.0e-5_dp
515 smear%fixed_mag_mom = -100.0_dp
516 smear%window_size = 0.0_dp
517 smear%smearing_width = 0.0_dp
519 END SUBROUTINE init_smear
526 SUBROUTINE read_smear_section(smear, smear_section)
530 REAL(kind=
dp),
DIMENSION(:),
POINTER :: r_vals
535 l_val=smear%do_smear)
536 IF (smear%do_smear)
THEN
540 r_val=smear%electronic_temperature)
542 r_val=smear%eps_fermi_dirac)
544 r_val=smear%window_size)
549 r_val=smear%smearing_width)
554 cpassert(
ASSOCIATED(r_vals))
555 ALLOCATE (smear%list(
SIZE(r_vals)))
559 r_val=smear%fixed_mag_mom)
561 END SUBROUTINE read_smear_section
567 SUBROUTINE init_gce(gce)
570 cpassert(.NOT.
ASSOCIATED(gce))
573 gce%target_workfunction = 0.16_dp
574 gce%prev_workfunction = -1001.0_dp
576 gce%mixing_coef = 0.3_dp
577 END SUBROUTINE init_gce
584 SUBROUTINE read_gce_section(gce, gce_section)
592 r_val=gce%target_workfunction)
594 r_val=gce%mixing_coef)
596 END SUBROUTINE read_gce_section
612 CHARACTER(LEN=*),
PARAMETER :: routinen =
'scf_c_write_parameters'
614 INTEGER :: handle, output_unit, roks_scheme
616 REAL(kind=
dp) :: elec_temp
623 CALL timeset(routinen, handle)
628 NULLIFY (scf_section)
635 IF (output_unit > 0)
THEN
637 IF (scf_control%max_scf > 0)
THEN
644 IF (.NOT. scf_control%non_selfconsistent .OR. scf_control%force_scf_calculation)
THEN
645 WRITE (unit=output_unit, &
646 fmt=
"(/,/,T2,A,T25,A,T51,A30,/,T25,56('-'),3(/,T25,A,T76,I5),/, "// &
647 "T25,56('-'),4(/,T25,A,T72,ES9.2),/,T25,56('-'), "// &
648 "1(/,T25,A,T71,F10.6))") &
650 "Density guess: ", adjustr(trim(
enum_i2c(enum, scf_control%density_guess))), &
651 "max_scf: ", scf_control%max_scf, &
652 "max_scf_history: ", scf_control%max_scf_hist, &
653 "max_diis: ", scf_control%max_diis, &
654 "eps_scf: ", scf_control%eps_scf, &
655 "eps_scf_history: ", scf_control%eps_scf_hist, &
656 "eps_diis: ", scf_control%eps_diis, &
657 "eps_eigval: ", scf_control%eps_eigval, &
658 "level_shift [a.u.]:", scf_control%level_shift
661 IF (sum(abs(scf_control%added_mos)) > 0)
THEN
662 WRITE (unit=output_unit, fmt=
"(T25,A,T71,2I5)") &
663 "added MOs ", scf_control%added_mos
666 IF (scf_control%diagonalization%mom)
THEN
668 WRITE (unit=output_unit, fmt=
"(T25,A)")
"MOM enabled"
671 IF (scf_control%mixing_method > 0 .AND. .NOT. scf_control%use_ot .AND. &
672 .NOT. scf_control%non_selfconsistent)
THEN
675 WRITE (unit=output_unit, fmt=
"(T25,A,/,T25,A,T51,A30)") &
677 "Mixing method: ", adjustr(trim(
enum_i2c(enum, scf_control%mixing_method)))
678 IF (scf_control%mixing_method > 1)
THEN
679 WRITE (unit=output_unit, fmt=
"(T47,A34)")
"charge density mixing in g-space"
682 IF (scf_control%smear%do_smear)
THEN
685 WRITE (unit=output_unit, fmt=
"(T25,A,/,T25,A,T51,A30)") &
687 "Smear method: ", adjustr(trim(
enum_i2c(enum, scf_control%smear%method)))
688 SELECT CASE (scf_control%smear%method)
692 WRITE (unit=output_unit, fmt=
"(T25,A,T61,F20.1)") &
693 "Electronic temperature [K]:", elec_temp
694 WRITE (unit=output_unit, fmt=
"(T25,A,T71,ES10.2)") &
695 "Electronic temperature [a.u.]:", scf_control%smear%electronic_temperature, &
696 "Accuracy threshold:", scf_control%smear%eps_fermi_dirac
697 IF (scf_control%smear%fixed_mag_mom > 0.0_dp)
WRITE (unit=output_unit, fmt=
"(T25,A,T61,F20.1)") &
698 "Fixed magnetic moment set to:", scf_control%smear%fixed_mag_mom
700 WRITE (unit=output_unit, fmt=
"(T25,A,T71,ES10.2)") &
701 "Smearing width (sigma) [a.u.]:", scf_control%smear%smearing_width, &
702 "Accuracy threshold:", scf_control%smear%eps_fermi_dirac
703 IF (scf_control%smear%fixed_mag_mom > 0.0_dp)
THEN
704 WRITE (unit=output_unit, fmt=
"(T25,A,T61,F20.1)") &
705 "Fixed magnetic moment set to:", scf_control%smear%fixed_mag_mom
708 WRITE (unit=output_unit, fmt=
"(T25,A,T71,F10.6)") &
709 "Smear window [a.u.]: ", scf_control%smear%window_size
713 IF (scf_control%gce%do_gce)
THEN
714 WRITE (unit=output_unit, fmt=
"(T25,A,/,T25,A,T61,F20.1)") &
716 "Target workfunction [eV]:", scf_control%gce%target_workfunction
717 WRITE (unit=output_unit, fmt=
"(T25,A,T61,F20.1)")
"Mixing coefficient:", scf_control%gce%mixing_coef
718 WRITE (unit=output_unit, fmt=
"(T25,A)")
"Grand canonical SCF is activated."
722 IF (roks .AND. (.NOT. scf_control%use_ot))
THEN
727 WRITE (unit=output_unit, fmt=
"(T25,A,/,T25,A,T51,A30)") &
729 "ROKS scheme:", adjustr(trim(
enum_i2c(enum, roks_scheme)))
730 SELECT CASE (roks_scheme)
732 WRITE (unit=output_unit, fmt=
"(T25,A,T71,F10.6)") &
733 "ROKS parameter f:", scf_control%roks_f
735 WRITE (unit=output_unit, &
736 fmt=
"(T25,A,6(/,T25,A,T71,F10.6))") &
737 "ROKS parameters: a)lpha, b)eta; c)losed, o)pen, v)irtual", &
738 "acc", scf_control%roks_parameter(2, 2, 1), &
739 "bcc", scf_control%roks_parameter(2, 2, 2), &
740 "aoo", scf_control%roks_parameter(1, 1, 1), &
741 "boo", scf_control%roks_parameter(1, 1, 2), &
742 "avv", scf_control%roks_parameter(0, 0, 1), &
743 "bvv", scf_control%roks_parameter(0, 0, 2)
748 IF (scf_control%outer_scf%have_scf)
THEN
749 WRITE (output_unit,
"(T25,56('-'),/,T25,A)")
"Outer loop SCF in use "
750 SELECT CASE (scf_control%outer_scf%type)
752 WRITE (output_unit,
'(T25,A)')
"No variables optimised in outer loop"
754 WRITE (output_unit,
'(T25,A)')
"DDAPC constraint enforced"
756 WRITE (output_unit,
'(T25,A)')
"S2 constraint enforced"
758 WRITE (output_unit,
'(T25,A)')
"Floating basis function optimization enforced"
760 cpabort(
"CDFT constraints must be defined in QS&CDFT")
762 cpabort(
"Unknown outer SCF type")
764 WRITE (output_unit,
'(T25,A,T72,ES9.2)')
"eps_scf", scf_control%outer_scf%eps_scf
765 WRITE (output_unit,
'(T25,A,T72,I9)')
"max_scf", scf_control%outer_scf%max_scf
766 SELECT CASE (scf_control%outer_scf%optimizer)
768 WRITE (output_unit,
'(T25,A)')
"No outer loop optimization"
770 WRITE (output_unit,
'(T25,A)')
"Steepest descent optimization"
772 WRITE (output_unit,
'(T25,A)')
"Gradient bisection"
773 WRITE (output_unit,
'(T25,A,T72,I9)')
"bisect_trust_count", scf_control%outer_scf%bisect_trust_count
775 WRITE (output_unit,
'(T25,A)')
"DIIS optimization"
776 WRITE (output_unit,
'(T25,A,T72,I9)')
"DIIS buffer length", &
777 scf_control%outer_scf%diis_buffer_length
780 cpabort(
"Selected optimizer only compatible with CDFT")
782 WRITE (output_unit,
'(T25,A)')
"Optimization with the secant method"
784 cpabort(
"Unknown outer SCF optimizer")
786 WRITE (output_unit,
'(T25,A,T72,ES9.2)')
"step_size", scf_control%outer_scf%step_size
788 WRITE (output_unit,
"(T25,56('-'),/,T25,A)")
"No outer SCF"
796 "PRINT%PROGRAM_RUN_INFO")
798 CALL timestop(handle)
809 SUBROUTINE ot_diag_read_input(settings, scf_section)
813 CHARACTER(len=*),
PARAMETER :: routinen =
'ot_diag_read_input'
815 INTEGER :: handle, output_unit
820 CALL timeset(routinen, handle)
836 "PRINT%PROGRAM_RUN_INFO")
838 CALL timestop(handle)
840 END SUBROUTINE ot_diag_read_input
various routines to log and control the output. The idea is that decisions about where to log should ...
type(cp_logger_type) function, pointer, public cp_get_default_logger()
returns the default logger
routines to handle the output, The idea is to remove the decision of wheter to output and what to out...
integer function, public cp_print_key_unit_nr(logger, basis_section, print_key_path, extension, middle_name, local, log_filename, ignore_should_output, file_form, file_position, file_action, file_status, do_backup, on_file, is_new_file, mpi_io, fout)
...
subroutine, public cp_print_key_finished_output(unit_nr, logger, basis_section, print_key_path, local, ignore_should_output, on_file, mpi_io)
should be called after you finish working with a unit obtained with cp_print_key_unit_nr,...
real(kind=dp) function, public cp_unit_from_cp2k(value, unit_str, defaults, power)
converts from the internal cp2k units to the given unit
Defines the basic variable types.
integer, parameter, public dp
An array-based list which grows on demand. When the internal array is full, a new array of twice the ...
parameters that control the outer loop of an SCF iteration
subroutine, public outer_scf_read_parameters(outer_scf, outer_scf_section)
reads the parameters of the outer_scf section into the given outer_scf
Control parameters for optimizers that work with CDFT constraints.
subroutine, public cdft_opt_type_release(cdft_opt_control)
releases the CDFT optimizer control object
subroutine, public qs_ot_settings_init(settings)
sets default values for the settings type
subroutine, public ot_readwrite_input(settings, ot_section, output_unit)
...
parameters that control an scf iteration
subroutine, public scf_c_read_parameters(scf_control, inp_section)
reads the parameters of the scf section into the given scf_control
subroutine, public scf_c_release(scf_control)
releases the given scf_control (see cp2k/doc/ReferenceCounting.html)
subroutine, public scf_c_write_parameters(scf_control, dft_section)
writes out the scf parameters
subroutine, public scf_c_create(scf_control)
allocates and initializes an scf control object with the default values
type of a logger, at the moment it contains just a print level starting at which level it should be l...
contains the parameters needed by a scf run
notice, this variable needs to be copyable, needed for spins as e.g. in qs_ot_scf
contains the parameters needed by a scf run