(git:f824184)
Loading...
Searching...
No Matches
qs_cdft_types.F
Go to the documentation of this file.
1!--------------------------------------------------------------------------------------------------!
2! CP2K: A general program to perform molecular dynamics simulations !
3! Copyright 2000-2026 CP2K developers group <https://cp2k.org> !
4! !
5! SPDX-License-Identifier: GPL-2.0-or-later !
6!--------------------------------------------------------------------------------------------------!
7
8! **************************************************************************************************
9!> \brief Defines CDFT control structures
10!> \par History
11!> separated from cp_control_types [03.2017]
12!> \author Nico Holmberg [03.2017]
13! **************************************************************************************************
14MODULE qs_cdft_types
15 USE cp_array_utils, ONLY: cp_1d_r_p_type
16 USE cp_dbcsr_api, ONLY: dbcsr_p_type
17 USE cp_fm_types, ONLY: cp_fm_type
18 USE hirshfeld_types, ONLY: hirshfeld_type,&
19 release_hirshfeld_type
20 USE input_constants, ONLY: becke_cutoff_global,&
21 outer_scf_becke_constraint,&
22 outer_scf_hirshfeld_constraint,&
23 outer_scf_none,&
24 radius_single,&
25 shape_function_gaussian
26 USE kinds, ONLY: default_path_length,&
27 dp
28 USE outer_scf_control_types, ONLY: outer_scf_control_type,&
29 qs_outer_scf_type
30 USE pw_types, ONLY: pw_r3d_rs_type
31 USE qs_cdft_opt_types, ONLY: cdft_opt_type_release
32#include "./base/base_uses.f90"
33
34 IMPLICIT NONE
35
36 PRIVATE
37
38! **************************************************************************************************
39!> \brief some parameters useful for becke_constraints
40!> \param aij pairwise parameters used to adjust the Becke cell boundaries built from atomic radii
41!> \param adjust logical which determines if the Becke potential is adjusted with atomic radii
42!> \param cavity the Gaussian confinement cavity: the constraint is nonzero outside this cavity
43!> \param cavity_confine logical which determines if cavity confinement is active
44!> \param cavity_mat a compacted version of cavity
45!> \param cavity_shape the confinement cavity shape id
46!> \param cavity_env the structure used to build the Gaussian cavity
47!> \param confine_bounds grid point indices outside which the constraint vanishes along Z-axis
48!> \param cutoff_type the cutoff type to use for building the constraint
49!> \param cutoffs element specific cutoffs
50!> \param cutoffs_tmp same as cutoffs but a temporary read during parsing of this type
51!> \param eps_cavity threshold used screen small values of the Gaussian cavity density
52!> \param in_memory logical which determines if the gradients of the Becke potential should be
53!> \param print_cavity logical to print the Gaussian confinement cavity
54!> \param radii permanent copy of radii_tmp
55!> \param radii_tmp temporary list of element specific atomic radii used to adjust the Becke cells
56!> \param rcavity an optional global radius parameter used to define the Gaussian confinement cavity
57!> \param rglobal global cutoff to use for building the constraint
58!> computed simultaneously with the potential instead of separately
59!> \param should_skip logical which determines is grid points should be skipped if all constraint
60!> atoms are found to reside beyond the cutoff distance from it
61!> \param use_bohr decides whether to use angstrom or bohr units for the confinement cavity radius
62! **************************************************************************************************
63 ! Utility vector container for building becke constraint
64 TYPE becke_vector_buffer
65 LOGICAL :: store_vectors = .false.
66 REAL(kind=dp), ALLOCATABLE, &
67 DIMENSION(:) :: distances
68 REAL(kind=dp), ALLOCATABLE, &
69 DIMENSION(:, :) :: distance_vecs, &
70 position_vecs, &
71 r12
72 REAL(kind=dp), ALLOCATABLE, &
73 DIMENSION(:, :, :) :: pair_dist_vecs
74 END TYPE becke_vector_buffer
75
76 TYPE becke_constraint_type
77 INTEGER :: cavity_shape = -1, cutoff_type = -1, &
78 confine_bounds(2) = -1
79 LOGICAL :: in_memory = .false., &
80 adjust = .false., cavity_confine = .false., &
81 should_skip = .false., print_cavity = .false., &
82 use_bohr = .false.
83 REAL(kind=dp) :: rglobal = -1.0_dp, &
84 rcavity = -1.0_dp, eps_cavity = -1.0_dp
85 REAL(kind=dp), DIMENSION(:), POINTER :: cutoffs => null(), cutoffs_tmp => null(), &
86 radii_tmp => null(), radii => null()
87 REAL(kind=dp), POINTER, &
88 DIMENSION(:, :) :: aij => null()
89 REAL(kind=dp), POINTER, &
90 DIMENSION(:, :, :) :: cavity_mat => null()
91 TYPE(becke_vector_buffer) :: vector_buffer = becke_vector_buffer()
92 TYPE(hirshfeld_type), POINTER :: cavity_env => null()
93 TYPE(pw_r3d_rs_type) :: cavity = pw_r3d_rs_type()
94 END TYPE becke_constraint_type
95
96! **************************************************************************************************
97! \brief control parameters for Hirshfeld constraints
98!> \param gaussian_shape the type of Gaussian to use (shape_function Gaussian)
99!> \param radii list of Gaussian radii for different atomic kinds
100!> \param radius Gaussian radius parameter
101!> \param shape_function the constraint type: atomic density or single Gaussian
102!> \param use_bohr determines whether to use angstrom or bohr units for the radii of Gaussians
103!> \param use_atomic_cutoff Logical to control use of ATOMIC_CUTOFF
104!> \param atomic_cutoff Numerical cutoff for calculation of Hirshfeld densities
105!> \param atoms_memory Number of atomic gradients to store in memory
106!> \param eps_cutoff Numerical cutoff for calculation of weight function
107!> \param print_density Logical to control printing of Hirshfeld densities to .cube file
108!> \param hirshfeld_env auxiliary type storing information about the Gaussians
109! **************************************************************************************************
110 TYPE hirshfeld_constraint_type
111 INTEGER :: gaussian_shape = -1, shape_function = -1, atoms_memory = -1
112 LOGICAL :: use_bohr = .false., print_density = .false., use_atomic_cutoff = .false.
113 REAL(kind=dp) :: radius = -1.0_dp, eps_cutoff = -1.0_dp, atomic_cutoff = -1.0_dp
114 REAL(kind=dp), DIMENSION(:), POINTER :: radii => null()
115 TYPE(hirshfeld_type), POINTER :: hirshfeld_env => null()
116 END TYPE hirshfeld_constraint_type
117
118! **************************************************************************************************
119!> \brief control parameters for CDFT simulations
120!> \param fragment_a_fname filename of cube file holding the total electron density
121!> of isolated fragment a
122!> \param fragment_b_fname filename of cube file holding the total electron density
123!> of isolated fragment b
124!> \param fragment_a_spin_fname filename of cube file holding the spin difference density
125!> of isolated fragment a
126!> \param fragment_b_spin_fname filename of cube file holding the spin difference density
127!> of isolated fragment b
128!> \param need_pot logical which determines if the Becke potential needs to be built
129!> \param save_pot logical which determines if the Becke potential should be saved until forces
130!> have been evaluated
131!> \param atomic_charges flag that determines if atomic CDFT charges should be computed
132!> \param total_steps counter to keep track of the total number of SCF steps
133!> \param type the type of CDFT constraint to use
134!> \param precond_freq preconditioner can be used if SCF converged in less than precond_freq steps
135!> \param nreused determines how many times the current OT preconditioner has been reused
136!> \param max_reuse the same preconditioner can be used a maximum of max_reuse times
137!> \param purge_freq determines how large nbad_conv can grow before purging the wfn/constraint history
138!> \param nbad_conv a running counter keeping track of the number of CDFT SCF loops when the first
139!> CDFT SCF iteration required more than 1 outer SCF loop. Reset when convergence is
140!> smooth
141!> \param purge_offset purging is only allowed when more than purge_offset steps have passed since
142!> last purge
143!> \param istep a counter to keep track of how many steps have passed since the last purge
144!> \param ienergy a counter tracking the total number of CDFT energy evaluations
145!> \param natoms the total number of atoms included in constraint/dummy atom groups
146!> \param atoms list of constraint atoms
147!> \param need_pot logical which determines if the constraint potential needs to be built
148!> \param save_pot logical which determines if the constraint potential should be saved until forces
149!> have been evaluated
150!> \param do_et logical which determines if a ET coupling calculation was requested
151!> \param reuse_precond logical which determines if a preconditioner can be reused
152!> \param purge_history logical which determines if the wfn/constraint history can be purged
153!> \param should_purge logical which determines if purging should take place after this CDFT SCF loop
154!> \param calculate_metric logical which determines if the ET coupling reliability metric is computed
155!> \param fragment_density use isolated fragment densities as a reference for the constraint
156!> \param fragments_integrated logical to determine if the fragment densities have been integrated
157!> \param flip_fragment should the spin difference density of the either fragment be flipped
158!> \param transfer_pot logical which determines if constraint should be saved for reuse later
159!> \param external_control logical which determines if the constraint has already been built
160!> in a mixed_env that holds multiple CDFT states
161!> \param first_iteration a flag to mark the first iteration for printing of additional data
162!> \param print_weight logical which determines if CDFT weight functions should be saved to a file
163!> \param in_memory logical which determines if the gradients of the Becke potential should be
164!> \param is_constraint list of logicals which determines if an atom is included in a constraint group
165!> \param strength Lagrangian multipliers of the constraints
166!> \param target target values of the constraints
167!> \param value integrated values of the constraints
168!> \param charges_fragment atomic partial charges computed from the isolated fragment densities
169!> \param becke_control control parameters for Becke constraints
170!> \param group container for atom groups each defining their own constraint
171!> \param occupations occupation numbers in case non-uniform MO occupation (for do_et)
172!> \param mo_coeff save the MO coeffs (for do_et)
173!> \param matrix_s save the overlap matrix (for do_et)
174!> \param wmat matrix representation of the weight function (for do_et)
175!> \param matrix_p save the density matrix (for calculate_metric)
176!> \param hirshfeld_control control parameters for Hirshfeld constraints
177!> \param constraint_control the outer_scf_control_type for the CDFT constraints
178!> \param ot_control the outer_scf_control_type for OT where data is stashed when outside the OT
179!> outer loop
180!> \param charge atomic CDFT real space potentials needed to calculate CDFT charges
181!> \param fragments container for isolated fragment densities read from cube files
182!> \param constraint holds information about the CDFT SCF loop
183! **************************************************************************************************
184 ! To build multiple constraints
185 TYPE cdft_group_type
186 ! Atoms of this constraint group
187 INTEGER, POINTER, DIMENSION(:) :: atoms => null()
188 ! Constraint type: charge constraint, magnetization density constraint, or spin channel specific constraint
189 INTEGER :: constraint_type = -1
190 ! Is the constraint fragment based
191 LOGICAL :: is_fragment_constraint = .false.
192 ! Temporary array holding a component of the weight function gradient that only includes
193 ! terms defined on constraint atoms
194 REAL(kind=dp), ALLOCATABLE, &
195 DIMENSION(:, :) :: d_sum_const_dr
196 ! Coefficients that determine how to sum up the atoms to form the constraint
197 REAL(kind=dp), POINTER, DIMENSION(:) :: coeff => null()
198 ! Result of integration dw/dR * rho_r dr where dw/dR is the weight function gradient
199 REAL(kind=dp), POINTER, &
200 DIMENSION(:, :) :: integrated => null()
201 ! Atomic gradients of the weight function at every grid point
202 REAL(kind=dp), POINTER, &
203 DIMENSION(:, :, :, :) :: gradients => null()
204 REAL(kind=dp), POINTER, &
205 DIMENSION(:, :, :, :) :: gradients_x => null()
206 REAL(kind=dp), POINTER, &
207 DIMENSION(:, :, :, :) :: gradients_y => null()
208 REAL(kind=dp), POINTER, &
209 DIMENSION(:, :, :, :) :: gradients_z => null()
210 ! The weight function of this constraint group
211 TYPE(pw_r3d_rs_type), POINTER :: weight => null()
212 TYPE(pw_r3d_rs_type), DIMENSION(:), POINTER :: hw_rho_atomic => null()
213 TYPE(pw_r3d_rs_type), DIMENSION(:), POINTER :: hw_rho_atomic_dr => null()
214 TYPE(pw_r3d_rs_type), DIMENSION(:), POINTER :: hw_rho_atomic_charge => null()
215 TYPE(pw_r3d_rs_type) :: hw_rho_total_constraint = pw_r3d_rs_type()
216 END TYPE cdft_group_type
217
218 TYPE cdft_control_type
219 CHARACTER(LEN=default_path_length) :: fragment_a_fname = "", &
220 fragment_b_fname = "", &
221 fragment_a_spin_fname = "", &
222 fragment_b_spin_fname = ""
223 INTEGER :: total_steps = -1, type = -1, &
224 precond_freq = -1, nreused = -1, max_reuse = -1, &
225 purge_freq = -1, nbad_conv = -1, purge_offset = -1, &
226 istep = -1, ienergy = -1, natoms = -1
227 INTEGER, POINTER, DIMENSION(:) :: atoms => null()
228 LOGICAL :: need_pot = .false., save_pot = .false., do_et = .false., &
229 reuse_precond = .false., purge_history = .false., &
230 should_purge = .false., calculate_metric = .false., &
231 atomic_charges = .false., fragment_density = .false., &
232 fragments_integrated = .false., flip_fragment(2) = .false., &
233 transfer_pot = .false., external_control = .false., &
234 first_iteration = .false., print_weight = .false., in_memory = .false.
235 LOGICAL, POINTER, DIMENSION(:) :: is_constraint => null()
236 REAL(kind=dp), DIMENSION(:), POINTER :: strength => null(), TARGET => null(), value => null()
237 REAL(kind=dp), POINTER, &
238 DIMENSION(:, :) :: charges_fragment => null()
239 TYPE(becke_constraint_type), POINTER :: becke_control => null()
240 TYPE(cdft_group_type), POINTER, &
241 DIMENSION(:) :: group => null()
242 TYPE(cp_1d_r_p_type), ALLOCATABLE, &
243 DIMENSION(:) :: occupations
244 TYPE(cp_fm_type), DIMENSION(:), &
245 POINTER :: mo_coeff => null()
246 TYPE(dbcsr_p_type) :: matrix_s
247 TYPE(dbcsr_p_type), DIMENSION(:), &
248 POINTER :: wmat => null(), matrix_p => null()
249 TYPE(hirshfeld_constraint_type), &
250 POINTER :: hirshfeld_control => null()
251 TYPE(outer_scf_control_type) :: constraint_control = outer_scf_control_type(), ot_control = outer_scf_control_type()
252 TYPE(pw_r3d_rs_type), POINTER, &
253 DIMENSION(:) :: charge => null()
254 TYPE(pw_r3d_rs_type), POINTER, &
255 DIMENSION(:, :) :: fragments => null()
256 TYPE(qs_outer_scf_type) :: constraint = qs_outer_scf_type()
257 TYPE(pw_r3d_rs_type) :: hw_rho_total = pw_r3d_rs_type()
258 END TYPE cdft_control_type
259
260 CHARACTER(len=*), PARAMETER, PRIVATE :: modulen = 'qs_cdft_types'
261
262 ! Public data types
263
264 PUBLIC :: becke_constraint_type, &
265 cdft_control_type, &
266 cdft_group_type, &
267 hirshfeld_constraint_type
268
269 ! Public subroutines
270
271 PUBLIC :: cdft_control_create, &
272 cdft_control_release
273
274CONTAINS
275
276! **************************************************************************************************
277!> \brief create the becke_constraint_type
278!> \param becke_control the structure to create
279!> \par History
280!> 02.2007 created [Florian Schiffmann]
281! **************************************************************************************************
282 SUBROUTINE becke_control_create(becke_control)
283 TYPE(becke_constraint_type), INTENT(OUT) :: becke_control
284
285 becke_control%adjust = .false.
286 becke_control%cutoff_type = becke_cutoff_global
287 becke_control%cavity_confine = .false.
288 becke_control%should_skip = .false.
289 becke_control%print_cavity = .false.
290 becke_control%in_memory = .false.
291 becke_control%use_bohr = .false.
292 becke_control%confine_bounds = 0
293 becke_control%rcavity = 3.0_dp
294 becke_control%rglobal = 6.0_dp
295 becke_control%eps_cavity = 1.0e-6_dp
296 becke_control%cavity_shape = radius_single
297 becke_control%vector_buffer%store_vectors = .true.
298 NULLIFY (becke_control%aij)
299 NULLIFY (becke_control%cavity_mat)
300 NULLIFY (becke_control%cavity_env)
301 NULLIFY (becke_control%cutoffs)
302 NULLIFY (becke_control%cutoffs_tmp)
303 NULLIFY (becke_control%radii)
304 NULLIFY (becke_control%radii_tmp)
305 END SUBROUTINE becke_control_create
306
307! **************************************************************************************************
308!> \brief release the becke_constraint_type
309!> \param becke_control the structure to release
310!> \par History
311!> 02.2007 created [Florian Schiffmann]
312! **************************************************************************************************
313 SUBROUTINE becke_control_release(becke_control)
314 TYPE(becke_constraint_type), INTENT(INOUT) :: becke_control
315
316 IF (becke_control%vector_buffer%store_vectors) THEN
317 IF (ALLOCATED(becke_control%vector_buffer%distances)) THEN
318 DEALLOCATE (becke_control%vector_buffer%distances)
319 END IF
320 IF (ALLOCATED(becke_control%vector_buffer%distance_vecs)) THEN
321 DEALLOCATE (becke_control%vector_buffer%distance_vecs)
322 END IF
323 IF (ALLOCATED(becke_control%vector_buffer%position_vecs)) THEN
324 DEALLOCATE (becke_control%vector_buffer%position_vecs)
325 END IF
326 IF (ALLOCATED(becke_control%vector_buffer%R12)) THEN
327 DEALLOCATE (becke_control%vector_buffer%R12)
328 END IF
329 IF (ALLOCATED(becke_control%vector_buffer%pair_dist_vecs)) THEN
330 DEALLOCATE (becke_control%vector_buffer%pair_dist_vecs)
331 END IF
332 END IF
333 IF (ASSOCIATED(becke_control%cutoffs)) THEN
334 DEALLOCATE (becke_control%cutoffs)
335 END IF
336 IF (ASSOCIATED(becke_control%cutoffs_tmp)) THEN
337 DEALLOCATE (becke_control%cutoffs_tmp)
338 END IF
339 IF (ASSOCIATED(becke_control%radii_tmp)) THEN
340 DEALLOCATE (becke_control%radii_tmp)
341 END IF
342 IF (ASSOCIATED(becke_control%radii)) THEN
343 DEALLOCATE (becke_control%radii)
344 END IF
345 IF (ASSOCIATED(becke_control%aij)) THEN
346 DEALLOCATE (becke_control%aij)
347 END IF
348 IF (ASSOCIATED(becke_control%cavity_mat)) THEN
349 DEALLOCATE (becke_control%cavity_mat)
350 END IF
351 IF (becke_control%cavity_confine) THEN
352 CALL release_hirshfeld_type(becke_control%cavity_env)
353 END IF
354
355 END SUBROUTINE becke_control_release
356
357! **************************************************************************************************
358!> \brief create the cdft_control_type
359!> \param cdft_control the structure to create
360!> \par History
361!> 12.2015 created [Nico Holmberg]
362! **************************************************************************************************
363 SUBROUTINE cdft_control_create(cdft_control)
364 TYPE(cdft_control_type), INTENT(OUT) :: cdft_control
365
366 cdft_control%total_steps = 0
367 NULLIFY (cdft_control%strength)
368 NULLIFY (cdft_control%target)
369 NULLIFY (cdft_control%value)
370 NULLIFY (cdft_control%atoms)
371 NULLIFY (cdft_control%is_constraint)
372 NULLIFY (cdft_control%charges_fragment)
373 NULLIFY (cdft_control%fragments)
374 NULLIFY (cdft_control%group)
375 NULLIFY (cdft_control%charge)
376 cdft_control%natoms = 0
377 cdft_control%type = outer_scf_none
378 cdft_control%need_pot = .true.
379 cdft_control%save_pot = .false.
380 cdft_control%transfer_pot = .false.
381 cdft_control%atomic_charges = .false.
382 cdft_control%first_iteration = .true.
383 cdft_control%fragment_density = .false.
384 cdft_control%fragments_integrated = .false.
385 cdft_control%flip_fragment = .false.
386 cdft_control%external_control = .false.
387 cdft_control%do_et = .false.
388 cdft_control%reuse_precond = .false.
389 cdft_control%nreused = 0
390 cdft_control%precond_freq = 0
391 cdft_control%max_reuse = 0
392 cdft_control%should_purge = .false.
393 cdft_control%purge_history = .false.
394 cdft_control%calculate_metric = .false.
395 cdft_control%in_memory = .false.
396 cdft_control%purge_freq = 0
397 cdft_control%nbad_conv = 0
398 cdft_control%purge_offset = 0
399 cdft_control%istep = 0
400 cdft_control%ienergy = 0
401 NULLIFY (cdft_control%becke_control)
402 ALLOCATE (cdft_control%becke_control)
403 CALL becke_control_create(cdft_control%becke_control)
404 NULLIFY (cdft_control%hirshfeld_control)
405 ALLOCATE (cdft_control%hirshfeld_control)
406 CALL hirshfeld_control_create(cdft_control%hirshfeld_control)
407 NULLIFY (cdft_control%wmat)
408 NULLIFY (cdft_control%matrix_s%matrix)
409 NULLIFY (cdft_control%mo_coeff)
410 NULLIFY (cdft_control%matrix_p)
411 ! Outer SCF default settings
412 cdft_control%ot_control%have_scf = .false.
413 cdft_control%ot_control%max_scf = 0
414 cdft_control%ot_control%eps_scf = 0.0_dp
415 cdft_control%ot_control%step_size = 0.0_dp
416 cdft_control%ot_control%type = -1
417 cdft_control%ot_control%optimizer = -1
418 cdft_control%ot_control%diis_buffer_length = -1
419 NULLIFY (cdft_control%ot_control%cdft_opt_control)
420 cdft_control%constraint_control%have_scf = .false.
421 cdft_control%constraint_control%max_scf = 0
422 cdft_control%constraint_control%eps_scf = 0.0_dp
423 cdft_control%constraint_control%step_size = 0.0_dp
424 cdft_control%constraint_control%type = -1
425 cdft_control%constraint_control%optimizer = -1
426 cdft_control%constraint_control%diis_buffer_length = -1
427 NULLIFY (cdft_control%constraint_control%cdft_opt_control)
428 cdft_control%constraint%iter_count = 0
429 NULLIFY (cdft_control%constraint%variables)
430 NULLIFY (cdft_control%constraint%gradient)
431 NULLIFY (cdft_control%constraint%energy)
432 NULLIFY (cdft_control%constraint%count)
433 NULLIFY (cdft_control%constraint%inv_jacobian)
434 cdft_control%constraint%deallocate_jacobian = .true.
435 END SUBROUTINE cdft_control_create
436
437! **************************************************************************************************
438!> \brief release the cdft_control_type
439!> \param cdft_control the structure to release
440!> \par History
441!> 12.2015 created [Nico Holmberg]
442! **************************************************************************************************
443 SUBROUTINE cdft_control_release(cdft_control)
444 TYPE(cdft_control_type), INTENT(INOUT) :: cdft_control
445
446 INTEGER :: i
447
448 ! Constraint settings
449 IF (ASSOCIATED(cdft_control%atoms)) THEN
450 DEALLOCATE (cdft_control%atoms)
451 END IF
452 IF (ASSOCIATED(cdft_control%strength)) THEN
453 DEALLOCATE (cdft_control%strength)
454 END IF
455 IF (ASSOCIATED(cdft_control%target)) THEN
456 DEALLOCATE (cdft_control%target)
457 END IF
458 IF (ASSOCIATED(cdft_control%value)) THEN
459 DEALLOCATE (cdft_control%value)
460 END IF
461 IF (ASSOCIATED(cdft_control%charges_fragment)) THEN
462 DEALLOCATE (cdft_control%charges_fragment)
463 END IF
464 IF (ASSOCIATED(cdft_control%fragments)) THEN
465 DEALLOCATE (cdft_control%fragments)
466 END IF
467 IF (ASSOCIATED(cdft_control%is_constraint)) THEN
468 DEALLOCATE (cdft_control%is_constraint)
469 END IF
470 IF (ASSOCIATED(cdft_control%charge)) THEN
471 DEALLOCATE (cdft_control%charge)
472 END IF
473 ! Constraint atom groups
474 IF (ASSOCIATED(cdft_control%group)) THEN
475 DO i = 1, SIZE(cdft_control%group)
476 IF (ASSOCIATED(cdft_control%group(i)%atoms)) THEN
477 DEALLOCATE (cdft_control%group(i)%atoms)
478 END IF
479 IF (ASSOCIATED(cdft_control%group(i)%coeff)) THEN
480 DEALLOCATE (cdft_control%group(i)%coeff)
481 END IF
482 IF (ALLOCATED(cdft_control%group(i)%d_sum_const_dR)) THEN
483 DEALLOCATE (cdft_control%group(i)%d_sum_const_dR)
484 END IF
485 IF (cdft_control%type == outer_scf_becke_constraint) THEN
486 IF (ASSOCIATED(cdft_control%group(i)%gradients)) THEN
487 DEALLOCATE (cdft_control%group(i)%gradients)
488 END IF
489 ELSE IF (cdft_control%type == outer_scf_hirshfeld_constraint) THEN
490 IF (ASSOCIATED(cdft_control%group(i)%gradients_x)) THEN
491 DEALLOCATE (cdft_control%group(i)%gradients_x)
492 END IF
493 IF (ASSOCIATED(cdft_control%group(i)%gradients_y)) THEN
494 DEALLOCATE (cdft_control%group(i)%gradients_y)
495 END IF
496 IF (ASSOCIATED(cdft_control%group(i)%gradients_z)) THEN
497 DEALLOCATE (cdft_control%group(i)%gradients_z)
498 END IF
499 END IF
500 IF (ASSOCIATED(cdft_control%group(i)%integrated)) THEN
501 DEALLOCATE (cdft_control%group(i)%integrated)
502 END IF
503 END DO
504 DEALLOCATE (cdft_control%group)
505 END IF
506 ! Constraint type specific deallocations
507 IF (ASSOCIATED(cdft_control%becke_control)) THEN
508 CALL becke_control_release(cdft_control%becke_control)
509 DEALLOCATE (cdft_control%becke_control)
510 END IF
511 IF (ASSOCIATED(cdft_control%hirshfeld_control)) THEN
512 CALL hirshfeld_control_release(cdft_control%hirshfeld_control)
513 DEALLOCATE (cdft_control%hirshfeld_control)
514 END IF
515 ! Release OUTER_SCF types
516 CALL cdft_opt_type_release(cdft_control%ot_control%cdft_opt_control)
517 CALL cdft_opt_type_release(cdft_control%constraint_control%cdft_opt_control)
518 IF (ASSOCIATED(cdft_control%constraint%variables)) THEN
519 DEALLOCATE (cdft_control%constraint%variables)
520 END IF
521 IF (ASSOCIATED(cdft_control%constraint%count)) THEN
522 DEALLOCATE (cdft_control%constraint%count)
523 END IF
524 IF (ASSOCIATED(cdft_control%constraint%gradient)) THEN
525 DEALLOCATE (cdft_control%constraint%gradient)
526 END IF
527 IF (ASSOCIATED(cdft_control%constraint%energy)) THEN
528 DEALLOCATE (cdft_control%constraint%energy)
529 END IF
530 IF (ASSOCIATED(cdft_control%constraint%inv_jacobian)) THEN
531 DEALLOCATE (cdft_control%constraint%inv_jacobian)
532 END IF
533 ! Storage for mixed CDFT calculations
534 IF (ALLOCATED(cdft_control%occupations)) THEN
535 DO i = 1, SIZE(cdft_control%occupations)
536 IF (ASSOCIATED(cdft_control%occupations(i)%array)) THEN
537 DEALLOCATE (cdft_control%occupations(i)%array)
538 END IF
539 END DO
540 DEALLOCATE (cdft_control%occupations)
541 END IF
542 ! Release control
543 cdft_control%type = outer_scf_none
544
545 END SUBROUTINE cdft_control_release
546
547! **************************************************************************************************
548!> \brief create the hirshfeld_constraint_type
549!> \param hirshfeld_control the structure to create
550!> \par History
551!> 09.2018 created [Nico Holmberg]
552! **************************************************************************************************
553 SUBROUTINE hirshfeld_control_create(hirshfeld_control)
554 TYPE(hirshfeld_constraint_type), INTENT(OUT) :: hirshfeld_control
555
556 hirshfeld_control%use_bohr = .false.
557 hirshfeld_control%print_density = .false.
558 hirshfeld_control%use_atomic_cutoff = .true.
559 hirshfeld_control%radius = 3.0_dp
560 hirshfeld_control%eps_cutoff = 1.0e-12_dp
561 hirshfeld_control%atomic_cutoff = 1.0e-12_dp
562 hirshfeld_control%shape_function = shape_function_gaussian
563 hirshfeld_control%atoms_memory = 80
564 hirshfeld_control%gaussian_shape = radius_single
565 NULLIFY (hirshfeld_control%hirshfeld_env)
566 NULLIFY (hirshfeld_control%radii)
567
568 END SUBROUTINE hirshfeld_control_create
569
570! **************************************************************************************************
571!> \brief release the hirshfeld_constraint_type
572!> \param hirshfeld_control the structure to release
573!> \par History
574!> 09.2018 created [Nico Holmberg]
575! **************************************************************************************************
576 SUBROUTINE hirshfeld_control_release(hirshfeld_control)
577 TYPE(hirshfeld_constraint_type), INTENT(INOUT) :: hirshfeld_control
578
579 IF (ASSOCIATED(hirshfeld_control%radii)) THEN
580 DEALLOCATE (hirshfeld_control%radii)
581 END IF
582 CALL release_hirshfeld_type(hirshfeld_control%hirshfeld_env)
583
584 END SUBROUTINE hirshfeld_control_release
585
586END MODULE qs_cdft_types
atomic_charges
simple routine to print charges for all atomic charge methods (currently mulliken,...
Definition atomic_charges.F:14
cp_array_utils
various utilities that regard array of different kinds: output, allocation,... maybe it is not a good...
Definition cp_array_utils.F:18
cp_dbcsr_api
Definition cp_dbcsr_api.F:8
cp_fm_types
represent a full matrix distributed on many processors
Definition cp_fm_types.F:15
hirshfeld_types
The types needed for the calculation of Hirshfeld charges and related functions.
Definition hirshfeld_types.F:15
hirshfeld_types::release_hirshfeld_type
subroutine, public release_hirshfeld_type(hirshfeld_env)
...
Definition hirshfeld_types.F:89
input_constants
collects all constants needed in input so that they can be used without circular dependencies
Definition input_constants.F:18
input_constants::outer_scf_becke_constraint
integer, parameter, public outer_scf_becke_constraint
Definition input_constants.F:773
input_constants::outer_scf_hirshfeld_constraint
integer, parameter, public outer_scf_hirshfeld_constraint
Definition input_constants.F:773
input_constants::shape_function_gaussian
integer, parameter, public shape_function_gaussian
Definition input_constants.F:677
input_constants::radius_single
integer, parameter, public radius_single
Definition input_constants.F:681
input_constants::outer_scf_none
integer, parameter, public outer_scf_none
Definition input_constants.F:773
input_constants::becke_cutoff_global
integer, parameter, public becke_cutoff_global
Definition input_constants.F:813
kinds
Defines the basic variable types.
Definition kinds.F:23
kinds::dp
integer, parameter, public dp
Definition kinds.F:34
kinds::default_path_length
integer, parameter, public default_path_length
Definition kinds.F:58
outer_scf_control_types
parameters that control the outer loop of an SCF iteration
Definition outer_scf_control_types.F:14
pw_types
Definition pw_types.F:24
qs_cdft_opt_types
Control parameters for optimizers that work with CDFT constraints.
Definition qs_cdft_opt_types.F:14
qs_cdft_opt_types::cdft_opt_type_release
subroutine, public cdft_opt_type_release(cdft_opt_control)
releases the CDFT optimizer control object
Definition qs_cdft_opt_types.F:134
qs_cdft_types
Defines CDFT control structures.
Definition qs_cdft_types.F:14
qs_cdft_types::cdft_control_release
subroutine, public cdft_control_release(cdft_control)
release the cdft_control_type
Definition qs_cdft_types.F:444
qs_cdft_types::cdft_control_create
subroutine, public cdft_control_create(cdft_control)
create the cdft_control_type
Definition qs_cdft_types.F:364
cp_array_utils::cp_1d_r_p_type
represent a pointer to a 1d array
Definition cp_array_utils.F:99
cp_dbcsr_api::dbcsr_p_type
Definition cp_dbcsr_api.F:172
cp_fm_types::cp_fm_type
represent a full matrix
Definition cp_fm_types.F:116
hirshfeld_types::hirshfeld_type
quantities needed for a Hirshfeld based partitioning of real space
Definition hirshfeld_types.F:36
outer_scf_control_types::outer_scf_control_type
contains the parameters needed by a scf run
Definition outer_scf_control_types.F:63
outer_scf_control_types::qs_outer_scf_type
Definition outer_scf_control_types.F:75
pw_types::pw_r3d_rs_type
Definition pw_types.F:62
qs_cdft_types::becke_constraint_type
Definition qs_cdft_types.F:76
qs_cdft_types::cdft_control_type
Definition qs_cdft_types.F:218
qs_cdft_types::cdft_group_type
control parameters for CDFT simulations
Definition qs_cdft_types.F:185
qs_cdft_types::hirshfeld_constraint_type
Definition qs_cdft_types.F:110