Line data Source code
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 routines that optimize a functional using the limited memory bfgs
10 : !> quasi-newton method.
11 : !> The process set up so that a master runs the real optimizer and the
12 : !> others help then to calculate the objective function.
13 : !> The arguments for the objective function are physically present in
14 : !> every processor (nedeed in the actual implementation of pao).
15 : !> In the future tha arguments themselves could be distributed.
16 : !> \par History
17 : !> 09.2003 globenv->para_env, retain/release, better parallel behaviour
18 : !> 01.2020 Space Group Symmetry introduced by Pierre-André Cazade [pcazade]
19 : !> \author Fawzi Mohamed
20 : !> @version 2.2002
21 : ! **************************************************************************************************
22 : MODULE cp_lbfgs_optimizer_gopt
23 : USE cp_lbfgs, ONLY: setulb
24 : USE cp_log_handling, ONLY: cp_get_default_logger, &
25 : cp_logger_type, &
26 : cp_to_string
27 : USE cp_output_handling, ONLY: cp_print_key_finished_output, &
28 : cp_print_key_unit_nr
29 : USE message_passing, ONLY: mp_para_env_release
30 : USE message_passing, ONLY: mp_para_env_type
31 : USE cp_subsys_types, ONLY: cp_subsys_type
32 : USE force_env_types, ONLY: force_env_get, &
33 : force_env_type
34 : USE gopt_f_methods, ONLY: gopt_f_io
35 : USE gopt_f_types, ONLY: gopt_f_release, &
36 : gopt_f_retain, &
37 : gopt_f_type
38 : USE gopt_param_types, ONLY: gopt_param_type
39 : USE input_section_types, ONLY: section_vals_type
40 : USE kinds, ONLY: dp
41 : USE machine, ONLY: m_walltime
42 : USE space_groups, ONLY: spgr_apply_rotations_coord, &
43 : spgr_apply_rotations_force
44 : USE space_groups_types, ONLY: spgr_type
45 : #include "../base/base_uses.f90"
46 :
47 : IMPLICIT NONE
48 : PRIVATE
49 :
50 : #:include "gopt_f77_methods.fypp"
51 :
52 : LOGICAL, PRIVATE, PARAMETER :: debug_this_module = .TRUE.
53 : CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'cp_lbfgs_optimizer_gopt'
54 :
55 : ! types
56 : PUBLIC :: cp_lbfgs_opt_gopt_type
57 :
58 : ! core methods
59 :
60 : ! special methos
61 :
62 : ! underlying functions
63 : PUBLIC :: cp_opt_gopt_create, cp_opt_gopt_release, &
64 : cp_opt_gopt_next, &
65 : cp_opt_gopt_stop
66 :
67 : ! **************************************************************************************************
68 : !> \brief info for the optimizer (see the description of this module)
69 : !> \param task the actual task of the optimizer (in the master it is up to
70 : !> date, in case of error also the minions one get updated.
71 : !> \param csave internal character string used by the lbfgs optimizer,
72 : !> meaningful only in the master
73 : !> \param lsave logical array used by the lbfgs optimizer, updated only
74 : !> in the master
75 : !> On exit with task = 'NEW_X', the following information is
76 : !> available:
77 : !> lsave(1) = .true. the initial x did not satisfy the bounds;
78 : !> lsave(2) = .true. the problem contains bounds;
79 : !> lsave(3) = .true. each variable has upper and lower bounds.
80 : !> \param ref_count reference count (see doc/ReferenceCounting.html)
81 : !> \param m the dimension of the subspace used to approximate the second
82 : !> derivative
83 : !> \param print_every every how many iterations output should be written.
84 : !> if 0 only at end, if print_every<0 never
85 : !> \param master the pid of the master processor
86 : !> \param max_f_per_iter the maximum number of function evaluations per
87 : !> iteration
88 : !> \param status 0: just initialized, 1: f g calculation,
89 : !> 2: begin new iteration, 3: ended iteration,
90 : !> 4: normal (converged) exit, 5: abnormal (error) exit,
91 : !> 6: daellocated
92 : !> \param n_iter the actual iteration number
93 : !> \param kind_of_bound an array with 0 (no bound), 1 (lower bound),
94 : !> 2 (both bounds), 3 (upper bound), to describe the bounds
95 : !> of every variable
96 : !> \param i_work_array an integer workarray of dimension 3*n, present only
97 : !> in the master
98 : !> \param isave is an INTEGER working array of dimension 44.
99 : !> On exit with task = 'NEW_X', it contains information that
100 : !> the user may want to access:
101 : !> \param isave (30) = the current iteration number;
102 : !> \param isave (34) = the total number of function and gradient
103 : !> evaluations;
104 : !> \param isave (36) = the number of function value or gradient
105 : !> evaluations in the current iteration;
106 : !> \param isave (38) = the number of free variables in the current
107 : !> iteration;
108 : !> \param isave (39) = the number of active constraints at the current
109 : !> iteration;
110 : !> \param f the actual best value of the object function
111 : !> \param wanted_relative_f_delta the wanted relative error on f
112 : !> (to be multiplied by epsilon), 0.0 -> no check
113 : !> \param wanted_projected_gradient the wanted error on the projected
114 : !> gradient (hessian times the gradient), 0.0 -> no check
115 : !> \param last_f the value of f in the last iteration
116 : !> \param projected_gradient the value of the sup norm of the projected
117 : !> gradient
118 : !> \param x the actual evaluation point (best one if converged or stopped)
119 : !> \param lower_bound the lower bounds
120 : !> \param upper_bound the upper bounds
121 : !> \param gradient the actual gradient
122 : !> \param dsave info date for lbfgs (master only)
123 : !> \param work_array a work array for lbfgs (master only)
124 : !> \param para_env the parallel environment for this optimizer
125 : !> \param obj_funct the objective function to be optimized
126 : !> \par History
127 : !> none
128 : !> \author Fawzi Mohamed
129 : !> @version 2.2002
130 : ! **************************************************************************************************
131 : TYPE cp_lbfgs_opt_gopt_type
132 : CHARACTER(len=60) :: task = ""
133 : CHARACTER(len=60) :: csave = ""
134 : LOGICAL :: lsave(4) = .FALSE.
135 : INTEGER :: m = 0, print_every = 0, master = 0, max_f_per_iter = 0, status = 0, n_iter = 0
136 : INTEGER, DIMENSION(:), POINTER :: kind_of_bound => NULL(), i_work_array => NULL(), isave => NULL()
137 : REAL(kind=dp) :: f = 0.0_dp, wanted_relative_f_delta = 0.0_dp, wanted_projected_gradient = 0.0_dp, &
138 : last_f = 0.0_dp, projected_gradient = 0.0_dp, eold = 0.0_dp, emin = 0.0_dp, trust_radius = 0.0_dp
139 : REAL(kind=dp), DIMENSION(:), POINTER :: x => NULL(), lower_bound => NULL(), upper_bound => NULL(), &
140 : gradient => NULL(), dsave => NULL(), work_array => NULL()
141 : TYPE(mp_para_env_type), POINTER :: para_env => NULL()
142 : TYPE(gopt_f_type), POINTER :: obj_funct => NULL()
143 : END TYPE cp_lbfgs_opt_gopt_type
144 :
145 : CONTAINS
146 :
147 : ! **************************************************************************************************
148 : !> \brief initializes the optimizer
149 : !> \param optimizer ...
150 : !> \param para_env ...
151 : !> \param obj_funct ...
152 : !> \param x0 ...
153 : !> \param m ...
154 : !> \param print_every ...
155 : !> \param wanted_relative_f_delta ...
156 : !> \param wanted_projected_gradient ...
157 : !> \param lower_bound ...
158 : !> \param upper_bound ...
159 : !> \param kind_of_bound ...
160 : !> \param master ...
161 : !> \param max_f_per_iter ...
162 : !> \param trust_radius ...
163 : !> \par History
164 : !> 02.2002 created [fawzi]
165 : !> 09.2003 refactored (retain/release,para_env) [fawzi]
166 : !> \author Fawzi Mohamed
167 : !> \note
168 : !> redirects the lbfgs output the the default unit
169 : ! **************************************************************************************************
170 540 : SUBROUTINE cp_opt_gopt_create(optimizer, para_env, obj_funct, x0, m, print_every, &
171 0 : wanted_relative_f_delta, wanted_projected_gradient, lower_bound, upper_bound, &
172 0 : kind_of_bound, master, max_f_per_iter, trust_radius)
173 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(OUT) :: optimizer
174 : TYPE(mp_para_env_type), POINTER :: para_env
175 : TYPE(gopt_f_type), POINTER :: obj_funct
176 : REAL(kind=dp), DIMENSION(:), INTENT(in) :: x0
177 : INTEGER, INTENT(in), OPTIONAL :: m, print_every
178 : REAL(kind=dp), INTENT(in), OPTIONAL :: wanted_relative_f_delta, &
179 : wanted_projected_gradient
180 : REAL(kind=dp), DIMENSION(SIZE(x0)), INTENT(in), &
181 : OPTIONAL :: lower_bound, upper_bound
182 : INTEGER, DIMENSION(SIZE(x0)), INTENT(in), OPTIONAL :: kind_of_bound
183 : INTEGER, INTENT(in), OPTIONAL :: master, max_f_per_iter
184 : REAL(kind=dp), INTENT(in), OPTIONAL :: trust_radius
185 :
186 : CHARACTER(len=*), PARAMETER :: routineN = 'cp_opt_gopt_create'
187 :
188 : INTEGER :: handle, lenwa, n
189 :
190 90 : CALL timeset(routineN, handle)
191 :
192 : NULLIFY (optimizer%kind_of_bound, &
193 90 : optimizer%i_work_array, &
194 90 : optimizer%isave, &
195 90 : optimizer%x, &
196 90 : optimizer%lower_bound, &
197 90 : optimizer%upper_bound, &
198 90 : optimizer%gradient, &
199 90 : optimizer%dsave, &
200 90 : optimizer%work_array, &
201 : optimizer%para_env, &
202 90 : optimizer%obj_funct)
203 90 : n = SIZE(x0)
204 90 : optimizer%m = 4
205 90 : IF (PRESENT(m)) optimizer%m = m
206 90 : optimizer%master = para_env%source
207 90 : optimizer%para_env => para_env
208 90 : CALL para_env%retain()
209 90 : optimizer%obj_funct => obj_funct
210 90 : CALL gopt_f_retain(obj_funct)
211 90 : optimizer%max_f_per_iter = 20
212 90 : IF (PRESENT(max_f_per_iter)) optimizer%max_f_per_iter = max_f_per_iter
213 90 : optimizer%print_every = -1
214 90 : optimizer%n_iter = 0
215 90 : optimizer%f = -1.0_dp
216 90 : optimizer%last_f = -1.0_dp
217 90 : optimizer%projected_gradient = -1.0_dp
218 90 : IF (PRESENT(print_every)) optimizer%print_every = print_every
219 90 : IF (PRESENT(master)) optimizer%master = master
220 90 : IF (optimizer%master == optimizer%para_env%mepos) THEN
221 : !MK This has to be adapted for a new L-BFGS version possibly
222 45 : lenwa = 2*optimizer%m*n + 5*n + 11*optimizer%m*optimizer%m + 8*optimizer%m
223 : ALLOCATE (optimizer%kind_of_bound(n), optimizer%i_work_array(3*n), &
224 225 : optimizer%isave(44))
225 : ALLOCATE (optimizer%x(n), optimizer%lower_bound(n), &
226 : optimizer%upper_bound(n), optimizer%gradient(n), &
227 360 : optimizer%dsave(29), optimizer%work_array(lenwa))
228 28632 : optimizer%x = x0
229 45 : optimizer%task = 'START'
230 85806 : optimizer%i_work_array = 0
231 2025 : optimizer%isave = 0
232 28632 : optimizer%lower_bound = 0.0_dp
233 28632 : optimizer%upper_bound = 0.0_dp
234 28632 : optimizer%gradient = 0.0_dp
235 1350 : optimizer%dsave = 0.0_dp
236 544950 : optimizer%work_array = 0.0_dp
237 45 : IF (PRESENT(wanted_relative_f_delta)) &
238 45 : optimizer%wanted_relative_f_delta = wanted_relative_f_delta
239 45 : IF (PRESENT(wanted_projected_gradient)) &
240 45 : optimizer%wanted_projected_gradient = wanted_projected_gradient
241 28632 : optimizer%kind_of_bound = 0
242 45 : IF (PRESENT(kind_of_bound)) optimizer%kind_of_bound = kind_of_bound
243 45 : IF (PRESENT(lower_bound)) optimizer%lower_bound = lower_bound
244 45 : IF (PRESENT(upper_bound)) optimizer%upper_bound = upper_bound
245 45 : IF (PRESENT(trust_radius)) optimizer%trust_radius = trust_radius
246 :
247 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
248 : optimizer%lower_bound, optimizer%upper_bound, &
249 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
250 : optimizer%wanted_relative_f_delta, &
251 : optimizer%wanted_projected_gradient, optimizer%work_array, &
252 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
253 : optimizer%csave, optimizer%lsave, optimizer%isave, &
254 45 : optimizer%dsave, optimizer%trust_radius)
255 : ELSE
256 : NULLIFY ( &
257 45 : optimizer%kind_of_bound, optimizer%i_work_array, optimizer%isave, &
258 45 : optimizer%lower_bound, optimizer%upper_bound, optimizer%gradient, &
259 45 : optimizer%dsave, optimizer%work_array)
260 135 : ALLOCATE (optimizer%x(n))
261 28632 : optimizer%x(:) = 0.0_dp
262 90 : ALLOCATE (optimizer%gradient(n))
263 28632 : optimizer%gradient(:) = 0.0_dp
264 : END IF
265 114438 : CALL optimizer%para_env%bcast(optimizer%x, optimizer%master)
266 90 : optimizer%status = 0
267 :
268 90 : CALL timestop(handle)
269 :
270 90 : END SUBROUTINE cp_opt_gopt_create
271 :
272 : ! **************************************************************************************************
273 : !> \brief releases the optimizer (see doc/ReferenceCounting.html)
274 : !> \param optimizer the object that should be released
275 : !> \par History
276 : !> 02.2002 created [fawzi]
277 : !> 09.2003 dealloc_ref->release [fawzi]
278 : !> \author Fawzi Mohamed
279 : ! **************************************************************************************************
280 90 : SUBROUTINE cp_opt_gopt_release(optimizer)
281 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(INOUT) :: optimizer
282 :
283 : CHARACTER(len=*), PARAMETER :: routineN = 'cp_opt_gopt_release'
284 :
285 : INTEGER :: handle
286 :
287 90 : CALL timeset(routineN, handle)
288 :
289 90 : IF (ASSOCIATED(optimizer%kind_of_bound)) THEN
290 45 : DEALLOCATE (optimizer%kind_of_bound)
291 : END IF
292 90 : IF (ASSOCIATED(optimizer%i_work_array)) THEN
293 45 : DEALLOCATE (optimizer%i_work_array)
294 : END IF
295 90 : IF (ASSOCIATED(optimizer%isave)) THEN
296 45 : DEALLOCATE (optimizer%isave)
297 : END IF
298 90 : IF (ASSOCIATED(optimizer%x)) THEN
299 90 : DEALLOCATE (optimizer%x)
300 : END IF
301 90 : IF (ASSOCIATED(optimizer%lower_bound)) THEN
302 45 : DEALLOCATE (optimizer%lower_bound)
303 : END IF
304 90 : IF (ASSOCIATED(optimizer%upper_bound)) THEN
305 45 : DEALLOCATE (optimizer%upper_bound)
306 : END IF
307 90 : IF (ASSOCIATED(optimizer%gradient)) THEN
308 90 : DEALLOCATE (optimizer%gradient)
309 : END IF
310 90 : IF (ASSOCIATED(optimizer%dsave)) THEN
311 45 : DEALLOCATE (optimizer%dsave)
312 : END IF
313 90 : IF (ASSOCIATED(optimizer%work_array)) THEN
314 45 : DEALLOCATE (optimizer%work_array)
315 : END IF
316 90 : CALL mp_para_env_release(optimizer%para_env)
317 90 : CALL gopt_f_release(optimizer%obj_funct)
318 :
319 90 : CALL timestop(handle)
320 90 : END SUBROUTINE cp_opt_gopt_release
321 :
322 : ! **************************************************************************************************
323 : !> \brief takes different valuse from the optimizer
324 : !> \param optimizer ...
325 : !> \param para_env ...
326 : !> \param obj_funct ...
327 : !> \param m ...
328 : !> \param print_every ...
329 : !> \param wanted_relative_f_delta ...
330 : !> \param wanted_projected_gradient ...
331 : !> \param x ...
332 : !> \param lower_bound ...
333 : !> \param upper_bound ...
334 : !> \param kind_of_bound ...
335 : !> \param master ...
336 : !> \param actual_projected_gradient ...
337 : !> \param n_var ...
338 : !> \param n_iter ...
339 : !> \param status ...
340 : !> \param max_f_per_iter ...
341 : !> \param at_end ...
342 : !> \param is_master ...
343 : !> \param last_f ...
344 : !> \param f ...
345 : !> \par History
346 : !> none
347 : !> \author Fawzi Mohamed
348 : !> @version 2.2002
349 : ! **************************************************************************************************
350 0 : SUBROUTINE cp_opt_gopt_get(optimizer, para_env, &
351 : obj_funct, m, print_every, &
352 : wanted_relative_f_delta, wanted_projected_gradient, &
353 : x, lower_bound, upper_bound, kind_of_bound, master, &
354 : actual_projected_gradient, &
355 : n_var, n_iter, status, max_f_per_iter, at_end, &
356 : is_master, last_f, f)
357 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(IN) :: optimizer
358 : TYPE(mp_para_env_type), OPTIONAL, POINTER :: para_env
359 : TYPE(gopt_f_type), OPTIONAL, POINTER :: obj_funct
360 : INTEGER, INTENT(out), OPTIONAL :: m, print_every
361 : REAL(kind=dp), INTENT(out), OPTIONAL :: wanted_relative_f_delta, &
362 : wanted_projected_gradient
363 : REAL(kind=dp), DIMENSION(:), OPTIONAL, POINTER :: x, lower_bound, upper_bound
364 : INTEGER, DIMENSION(:), OPTIONAL, POINTER :: kind_of_bound
365 : INTEGER, INTENT(out), OPTIONAL :: master
366 : REAL(kind=dp), INTENT(out), OPTIONAL :: actual_projected_gradient
367 : INTEGER, INTENT(out), OPTIONAL :: n_var, n_iter, status, max_f_per_iter
368 : LOGICAL, INTENT(out), OPTIONAL :: at_end, is_master
369 : REAL(kind=dp), INTENT(out), OPTIONAL :: last_f, f
370 :
371 0 : IF (PRESENT(is_master)) is_master = optimizer%master == optimizer%para_env%mepos
372 0 : IF (PRESENT(master)) master = optimizer%master
373 0 : IF (PRESENT(status)) status = optimizer%status
374 0 : IF (PRESENT(para_env)) para_env => optimizer%para_env
375 0 : IF (PRESENT(obj_funct)) obj_funct = optimizer%obj_funct
376 0 : IF (PRESENT(m)) m = optimizer%m
377 0 : IF (PRESENT(max_f_per_iter)) max_f_per_iter = optimizer%max_f_per_iter
378 0 : IF (PRESENT(wanted_projected_gradient)) &
379 0 : wanted_projected_gradient = optimizer%wanted_projected_gradient
380 0 : IF (PRESENT(wanted_relative_f_delta)) &
381 0 : wanted_relative_f_delta = optimizer%wanted_relative_f_delta
382 0 : IF (PRESENT(print_every)) print_every = optimizer%print_every
383 0 : IF (PRESENT(x)) x => optimizer%x
384 0 : IF (PRESENT(n_var)) n_var = SIZE(x)
385 0 : IF (PRESENT(lower_bound)) lower_bound => optimizer%lower_bound
386 0 : IF (PRESENT(upper_bound)) upper_bound => optimizer%upper_bound
387 0 : IF (PRESENT(kind_of_bound)) kind_of_bound => optimizer%kind_of_bound
388 0 : IF (PRESENT(n_iter)) n_iter = optimizer%n_iter
389 0 : IF (PRESENT(last_f)) last_f = optimizer%last_f
390 0 : IF (PRESENT(f)) f = optimizer%f
391 0 : IF (PRESENT(at_end)) at_end = optimizer%status > 3
392 0 : IF (PRESENT(actual_projected_gradient)) &
393 0 : actual_projected_gradient = optimizer%projected_gradient
394 0 : IF (optimizer%master == optimizer%para_env%mepos) THEN
395 0 : IF (optimizer%isave(30) > 1 .AND. (optimizer%task(1:5) == "NEW_X" .OR. &
396 : optimizer%task(1:4) == "STOP" .AND. optimizer%task(7:9) == "CPU")) THEN
397 : ! nr iterations >1 .and. dsave contains the wanted data
398 0 : IF (PRESENT(last_f)) last_f = optimizer%dsave(2)
399 0 : IF (PRESENT(actual_projected_gradient)) &
400 0 : actual_projected_gradient = optimizer%dsave(13)
401 : ELSE
402 0 : CPASSERT(.NOT. PRESENT(last_f))
403 0 : CPASSERT(.NOT. PRESENT(actual_projected_gradient))
404 : END IF
405 0 : ELSE IF (PRESENT(lower_bound) .OR. PRESENT(upper_bound) .OR. PRESENT(kind_of_bound)) THEN
406 0 : CPWARN("asked undefined types")
407 : END IF
408 :
409 0 : END SUBROUTINE cp_opt_gopt_get
410 :
411 : ! **************************************************************************************************
412 : !> \brief does one optimization step
413 : !> \param optimizer ...
414 : !> \param n_iter ...
415 : !> \param f ...
416 : !> \param last_f ...
417 : !> \param projected_gradient ...
418 : !> \param converged ...
419 : !> \param geo_section ...
420 : !> \param force_env ...
421 : !> \param gopt_param ...
422 : !> \param spgr ...
423 : !> \par History
424 : !> 01.2020 modified [pcazade]
425 : !> \author Fawzi Mohamed
426 : !> @version 2.2002
427 : !> \note
428 : !> use directly mainlb in place of setulb ??
429 : ! **************************************************************************************************
430 2970 : SUBROUTINE cp_opt_gopt_step(optimizer, n_iter, f, last_f, &
431 : projected_gradient, converged, geo_section, force_env, &
432 : gopt_param, spgr)
433 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(INOUT) :: optimizer
434 : INTEGER, INTENT(out), OPTIONAL :: n_iter
435 : REAL(kind=dp), INTENT(out), OPTIONAL :: f, last_f, projected_gradient
436 : LOGICAL, INTENT(out), OPTIONAL :: converged
437 : TYPE(section_vals_type), POINTER :: geo_section
438 : TYPE(force_env_type), POINTER :: force_env
439 : TYPE(gopt_param_type), POINTER :: gopt_param
440 : TYPE(spgr_type), OPTIONAL, POINTER :: spgr
441 :
442 : CHARACTER(len=*), PARAMETER :: routineN = 'cp_opt_gopt_step'
443 :
444 : CHARACTER(LEN=5) :: wildcard
445 : INTEGER :: dataunit, handle, its
446 : LOGICAL :: conv, is_master, justEntred, &
447 : keep_space_group
448 : REAL(KIND=dp) :: t_diff, t_now, t_old
449 2970 : REAL(KIND=dp), DIMENSION(:), POINTER :: xold
450 : TYPE(cp_logger_type), POINTER :: logger
451 : TYPE(cp_subsys_type), POINTER :: subsys
452 :
453 2970 : NULLIFY (logger, xold)
454 5940 : logger => cp_get_default_logger()
455 2970 : CALL timeset(routineN, handle)
456 2970 : justEntred = .TRUE.
457 2970 : is_master = optimizer%master == optimizer%para_env%mepos
458 2970 : IF (PRESENT(converged)) converged = optimizer%status == 4
459 8910 : ALLOCATE (xold(SIZE(optimizer%x)))
460 :
461 : ! collecting subsys
462 2970 : CALL force_env_get(force_env, subsys=subsys)
463 :
464 2970 : keep_space_group = .FALSE.
465 2970 : IF (PRESENT(spgr)) THEN
466 2970 : IF (ASSOCIATED(spgr)) keep_space_group = spgr%keep_space_group
467 : END IF
468 :
469 : ! applies rotation matrices to coordinates
470 2970 : IF (keep_space_group) THEN
471 2 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
472 : END IF
473 :
474 1732326 : xold = optimizer%x
475 2970 : t_old = m_walltime()
476 :
477 2970 : IF (optimizer%status >= 4) THEN
478 0 : CPWARN("status>=4, trying to restart")
479 0 : optimizer%status = 0
480 : dataunit = cp_print_key_unit_nr(logger, geo_section, &
481 0 : "PRINT%PROGRAM_RUN_INFO", extension=".geoLog")
482 0 : IF (is_master) THEN
483 0 : optimizer%task = 'START'
484 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
485 : optimizer%lower_bound, optimizer%upper_bound, &
486 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
487 : optimizer%wanted_relative_f_delta, &
488 : optimizer%wanted_projected_gradient, optimizer%work_array, &
489 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
490 : optimizer%csave, optimizer%lsave, optimizer%isave, &
491 0 : optimizer%dsave, optimizer%trust_radius, spgr=spgr, iwunit=dataunit)
492 : END IF
493 : CALL cp_print_key_finished_output(dataunit, logger, geo_section, &
494 0 : "PRINT%PROGRAM_RUN_INFO")
495 : END IF
496 :
497 : DO
498 : dataunit = cp_print_key_unit_nr(logger, geo_section, &
499 9242 : "PRINT%PROGRAM_RUN_INFO", extension=".geoLog")
500 9242 : ifMaster: IF (is_master) THEN
501 4621 : IF (optimizer%task(1:7) == 'RESTART') THEN
502 : ! restart the optimizer
503 0 : optimizer%status = 0
504 0 : optimizer%task = 'START'
505 : ! applies rotation matrices to coordinates and forces
506 0 : IF (keep_space_group) THEN
507 0 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
508 0 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
509 : END IF
510 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
511 : optimizer%lower_bound, optimizer%upper_bound, &
512 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
513 : optimizer%wanted_relative_f_delta, &
514 : optimizer%wanted_projected_gradient, optimizer%work_array, &
515 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
516 : optimizer%csave, optimizer%lsave, optimizer%isave, &
517 0 : optimizer%dsave, optimizer%trust_radius, spgr=spgr, iwunit=dataunit)
518 0 : IF (keep_space_group) THEN
519 0 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
520 0 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
521 : END IF
522 : END IF
523 4621 : IF (optimizer%task(1:2) == 'FG') THEN
524 1695 : IF (optimizer%isave(36) > optimizer%max_f_per_iter) THEN
525 0 : optimizer%task = 'STOP: CPU, hit max f eval in iter'
526 0 : optimizer%status = 5 ! anormal exit
527 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
528 : optimizer%lower_bound, optimizer%upper_bound, &
529 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
530 : optimizer%wanted_relative_f_delta, &
531 : optimizer%wanted_projected_gradient, optimizer%work_array, &
532 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
533 : optimizer%csave, optimizer%lsave, optimizer%isave, &
534 0 : optimizer%dsave, optimizer%trust_radius, spgr=spgr, iwunit=dataunit)
535 : ELSE
536 1695 : optimizer%status = 1
537 : END IF
538 2926 : ELSE IF (optimizer%task(1:5) == 'NEW_X') THEN
539 2925 : IF (justEntred) THEN
540 1441 : optimizer%status = 2
541 : ! applies rotation matrices to coordinates and forces
542 1441 : IF (keep_space_group) THEN
543 0 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
544 0 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
545 : END IF
546 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
547 : optimizer%lower_bound, optimizer%upper_bound, &
548 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
549 : optimizer%wanted_relative_f_delta, &
550 : optimizer%wanted_projected_gradient, optimizer%work_array, &
551 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
552 : optimizer%csave, optimizer%lsave, optimizer%isave, &
553 1441 : optimizer%dsave, optimizer%trust_radius, spgr=spgr, iwunit=dataunit)
554 1441 : IF (keep_space_group) THEN
555 0 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
556 0 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
557 : END IF
558 : ELSE
559 : ! applies rotation matrices to coordinates and forces
560 1484 : IF (keep_space_group) THEN
561 1 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
562 1 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
563 : END IF
564 1484 : optimizer%status = 3
565 : END IF
566 1 : ELSE IF (optimizer%task(1:4) == 'CONV') THEN
567 1 : optimizer%status = 4
568 0 : ELSE IF (optimizer%task(1:4) == 'STOP') THEN
569 0 : optimizer%status = 5
570 0 : CPWARN("task became stop in an unknown way")
571 0 : ELSE IF (optimizer%task(1:5) == 'ERROR') THEN
572 0 : optimizer%status = 5
573 : ELSE
574 0 : CPWARN("unknown task '"//optimizer%task//"'")
575 : END IF
576 : END IF ifMaster
577 : CALL cp_print_key_finished_output(dataunit, logger, geo_section, &
578 9242 : "PRINT%PROGRAM_RUN_INFO")
579 9242 : CALL optimizer%para_env%bcast(optimizer%status, optimizer%master)
580 : ! Dump info
581 9242 : IF (optimizer%status == 3) THEN
582 2968 : its = 0
583 2968 : IF (is_master) THEN
584 : ! Iteration level is taken into account in the optimizer external loop
585 1484 : its = optimizer%isave(30)
586 : END IF
587 : END IF
588 : !
589 3390 : SELECT CASE (optimizer%status)
590 : CASE (1)
591 : !op=1 evaluate f and g
592 : CALL cp_eval_at(optimizer%obj_funct, x=optimizer%x, &
593 : f=optimizer%f, &
594 : gradient=optimizer%gradient, &
595 : final_evaluation=.FALSE., &
596 3390 : master=optimizer%master, para_env=optimizer%para_env)
597 : ! do not use keywords?
598 : dataunit = cp_print_key_unit_nr(logger, geo_section, &
599 3390 : "PRINT%PROGRAM_RUN_INFO", extension=".geoLog")
600 3390 : IF (is_master) THEN
601 : ! applies rotation matrices to coordinates and forces
602 1695 : IF (keep_space_group) THEN
603 2 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
604 2 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
605 : END IF
606 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
607 : optimizer%lower_bound, optimizer%upper_bound, &
608 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
609 : optimizer%wanted_relative_f_delta, &
610 : optimizer%wanted_projected_gradient, optimizer%work_array, &
611 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
612 : optimizer%csave, optimizer%lsave, optimizer%isave, &
613 1695 : optimizer%dsave, optimizer%trust_radius, spgr=spgr, iwunit=dataunit)
614 1695 : IF (keep_space_group) THEN
615 2 : CALL spgr_apply_rotations_coord(spgr, optimizer%x)
616 2 : CALL spgr_apply_rotations_force(spgr, optimizer%gradient)
617 : END IF
618 : END IF
619 : CALL cp_print_key_finished_output(dataunit, logger, geo_section, &
620 3390 : "PRINT%PROGRAM_RUN_INFO")
621 4168974 : CALL optimizer%para_env%bcast(optimizer%x, optimizer%master)
622 : CASE (2)
623 : !op=2 begin new iter
624 3347294 : CALL optimizer%para_env%bcast(optimizer%x, optimizer%master)
625 2882 : t_old = m_walltime()
626 : CASE (3)
627 : !op=3 ended iter
628 2968 : wildcard = "LBFGS"
629 : dataunit = cp_print_key_unit_nr(logger, geo_section, &
630 2968 : "PRINT%PROGRAM_RUN_INFO", extension=".geoLog")
631 2968 : IF (is_master) its = optimizer%isave(30)
632 2968 : CALL optimizer%para_env%bcast(its, optimizer%master)
633 :
634 : ! Some IO and Convergence check
635 2968 : t_now = m_walltime()
636 2968 : t_diff = t_now - t_old
637 2968 : t_old = t_now
638 : CALL gopt_f_io(optimizer%obj_funct, force_env, force_env%root_section, &
639 : its, optimizer%f, dataunit, optimizer%eold, optimizer%emin, wildcard, gopt_param, &
640 1732288 : SIZE(optimizer%x), optimizer%x - xold, optimizer%gradient, conv, used_time=t_diff)
641 2968 : CALL optimizer%para_env%bcast(conv, optimizer%master)
642 : CALL cp_print_key_finished_output(dataunit, logger, geo_section, &
643 2968 : "PRINT%PROGRAM_RUN_INFO")
644 2968 : optimizer%eold = optimizer%f
645 2968 : optimizer%emin = MIN(optimizer%emin, optimizer%eold)
646 1732288 : xold = optimizer%x
647 2968 : IF (PRESENT(converged)) converged = conv
648 2 : EXIT
649 : CASE (4)
650 : !op=4 (convergence - normal exit)
651 : ! Specific L-BFGS convergence criteria.. overrides the convergence criteria on
652 : ! stepsize and gradients
653 : dataunit = cp_print_key_unit_nr(logger, geo_section, &
654 2 : "PRINT%PROGRAM_RUN_INFO", extension=".geoLog")
655 2 : IF (dataunit > 0) THEN
656 1 : WRITE (dataunit, '(T2,A)') ""
657 1 : WRITE (dataunit, '(T2,A)') "************************************************"
658 1 : WRITE (dataunit, '(T2,A)') "* Specific L-BFGS convergence criteria *"
659 1 : WRITE (dataunit, '(T2,A)') "* WANTED_PROJ_GRADIENT and WANTED_REL_F_ERROR *"
660 1 : WRITE (dataunit, '(T2,A)') "* satisfied .... run CONVERGED! *"
661 1 : WRITE (dataunit, '(T2,A)') "* * * * *"
662 1 : WRITE (dataunit, '(T2,A)') "* General convergence criteria on stepsize and *"
663 1 : WRITE (dataunit, '(T2,A)') "* gradients may or may not have been satisfied *"
664 1 : WRITE (dataunit, '(T2,A)') "* yet; if unsatisfactory, try tightening the *"
665 1 : WRITE (dataunit, '(T2,A)') "* L-BFGS convergence criteria and restart run. *"
666 1 : WRITE (dataunit, '(T2,A)') "************************************************"
667 1 : WRITE (dataunit, '(T2,A)') ""
668 : END IF
669 : CALL cp_print_key_finished_output(dataunit, logger, geo_section, &
670 2 : "PRINT%PROGRAM_RUN_INFO")
671 2 : IF (PRESENT(converged)) converged = .TRUE.
672 0 : EXIT
673 : CASE (5)
674 : ! op=5 abnormal exit ()
675 0 : CALL optimizer%para_env%bcast(optimizer%task, optimizer%master)
676 : CASE (6)
677 : ! deallocated
678 0 : CPABORT("step on a deallocated opt structure ")
679 : CASE default
680 : CALL cp_abort(__LOCATION__, &
681 0 : "unknown status "//cp_to_string(optimizer%status))
682 0 : optimizer%status = 5
683 9242 : EXIT
684 : END SELECT
685 6272 : IF (optimizer%status == 1 .AND. justEntred) THEN
686 88 : optimizer%eold = optimizer%f
687 88 : optimizer%emin = optimizer%eold
688 : END IF
689 : justEntred = .FALSE.
690 : END DO
691 :
692 3461682 : CALL optimizer%para_env%bcast(optimizer%x, optimizer%master)
693 : CALL cp_opt_gopt_bcast_res(optimizer, &
694 : n_iter=optimizer%n_iter, &
695 : f=optimizer%f, last_f=optimizer%last_f, &
696 2970 : projected_gradient=optimizer%projected_gradient)
697 :
698 2970 : DEALLOCATE (xold)
699 2970 : IF (PRESENT(f)) f = optimizer%f
700 2970 : IF (PRESENT(last_f)) last_f = optimizer%last_f
701 2970 : IF (PRESENT(projected_gradient)) &
702 0 : projected_gradient = optimizer%projected_gradient
703 2970 : IF (PRESENT(n_iter)) n_iter = optimizer%n_iter
704 2970 : CALL timestop(handle)
705 :
706 2970 : END SUBROUTINE cp_opt_gopt_step
707 :
708 : ! **************************************************************************************************
709 : !> \brief returns the results (and broadcasts them)
710 : !> \param optimizer the optimizer object the info is taken from
711 : !> \param n_iter the number of iterations
712 : !> \param f the actual value of the objective function (f)
713 : !> \param last_f the last value of f
714 : !> \param projected_gradient the infinity norm of the projected gradient
715 : !> \par History
716 : !> none
717 : !> \author Fawzi Mohamed
718 : !> @version 2.2002
719 : !> \note
720 : !> private routine
721 : ! **************************************************************************************************
722 2970 : SUBROUTINE cp_opt_gopt_bcast_res(optimizer, n_iter, f, last_f, &
723 : projected_gradient)
724 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(IN) :: optimizer
725 : INTEGER, INTENT(out), OPTIONAL :: n_iter
726 : REAL(kind=dp), INTENT(inout), OPTIONAL :: f, last_f, projected_gradient
727 :
728 : REAL(kind=dp), DIMENSION(4) :: results
729 :
730 2970 : IF (optimizer%master == optimizer%para_env%mepos) THEN
731 : results = [REAL(optimizer%isave(30), kind=dp), &
732 7425 : optimizer%f, optimizer%dsave(2), optimizer%dsave(13)]
733 : END IF
734 2970 : CALL optimizer%para_env%bcast(results, optimizer%master)
735 2970 : IF (PRESENT(n_iter)) n_iter = NINT(results(1))
736 2970 : IF (PRESENT(f)) f = results(2)
737 2970 : IF (PRESENT(last_f)) last_f = results(3)
738 2970 : IF (PRESENT(projected_gradient)) &
739 2970 : projected_gradient = results(4)
740 :
741 2970 : END SUBROUTINE cp_opt_gopt_bcast_res
742 :
743 : ! **************************************************************************************************
744 : !> \brief goes to the next optimal point (after an optimizer iteration)
745 : !> returns true if converged
746 : !> \param optimizer the optimizer that goes to the next point
747 : !> \param n_iter ...
748 : !> \param f ...
749 : !> \param last_f ...
750 : !> \param projected_gradient ...
751 : !> \param converged ...
752 : !> \param geo_section ...
753 : !> \param force_env ...
754 : !> \param gopt_param ...
755 : !> \param spgr ...
756 : !> \return ...
757 : !> \par History
758 : !> 01.2020 modified [pcazade]
759 : !> \author Fawzi Mohamed
760 : !> @version 2.2002
761 : !> \note
762 : !> if you deactivate convergence control it returns never false
763 : ! **************************************************************************************************
764 2970 : FUNCTION cp_opt_gopt_next(optimizer, n_iter, f, last_f, &
765 : projected_gradient, converged, geo_section, force_env, &
766 : gopt_param, spgr) RESULT(res)
767 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(INOUT) :: optimizer
768 : INTEGER, INTENT(out), OPTIONAL :: n_iter
769 : REAL(kind=dp), INTENT(out), OPTIONAL :: f, last_f, projected_gradient
770 : LOGICAL, INTENT(out) :: converged
771 : TYPE(section_vals_type), POINTER :: geo_section
772 : TYPE(force_env_type), POINTER :: force_env
773 : TYPE(gopt_param_type), POINTER :: gopt_param
774 : TYPE(spgr_type), OPTIONAL, POINTER :: spgr
775 : LOGICAL :: res
776 :
777 : ! passes spgr structure if present
778 : CALL cp_opt_gopt_step(optimizer, n_iter=n_iter, f=f, &
779 : last_f=last_f, projected_gradient=projected_gradient, &
780 : converged=converged, geo_section=geo_section, &
781 2970 : force_env=force_env, gopt_param=gopt_param, spgr=spgr)
782 2970 : res = (optimizer%status < 40) .AND. .NOT. converged
783 :
784 2970 : END FUNCTION cp_opt_gopt_next
785 :
786 : ! **************************************************************************************************
787 : !> \brief stops the optimization
788 : !> \param optimizer ...
789 : !> \par History
790 : !> none
791 : !> \author Fawzi Mohamed
792 : !> @version 2.2002
793 : ! **************************************************************************************************
794 0 : SUBROUTINE cp_opt_gopt_stop(optimizer)
795 : TYPE(cp_lbfgs_opt_gopt_type), INTENT(INOUT) :: optimizer
796 :
797 0 : optimizer%task = 'STOPPED on user request'
798 0 : optimizer%status = 4 ! normal exit
799 0 : IF (optimizer%master == optimizer%para_env%mepos) THEN
800 : CALL setulb(SIZE(optimizer%x), optimizer%m, optimizer%x, &
801 : optimizer%lower_bound, optimizer%upper_bound, &
802 : optimizer%kind_of_bound, optimizer%f, optimizer%gradient, &
803 : optimizer%wanted_relative_f_delta, &
804 : optimizer%wanted_projected_gradient, optimizer%work_array, &
805 : optimizer%i_work_array, optimizer%task, optimizer%print_every, &
806 : optimizer%csave, optimizer%lsave, optimizer%isave, &
807 0 : optimizer%dsave, optimizer%trust_radius)
808 : END IF
809 :
810 0 : END SUBROUTINE cp_opt_gopt_stop
811 :
812 0 : END MODULE cp_lbfgs_optimizer_gopt
|
