(git:27c966b)
Loading...
Searching...
No Matches
cell_opt.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 performs CELL optimization
10!> \par History
11!> 03.2008 - Teodoro Laino [tlaino] - University of Zurich - Cell Optimization
12! **************************************************************************************************
23 USE gopt_f_types, ONLY: gopt_f_create,&
33 USE kinds, ONLY: dp
34#include "../base/base_uses.f90"
35
36 IMPLICIT NONE
37 PRIVATE
38 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'cell_opt'
39
40 PUBLIC :: cp_cell_opt
41
42CONTAINS
43
44! **************************************************************************************************
45!> \brief Main driver to perform geometry optimization
46!> \param force_env ...
47!> \param globenv ...
48!> \author Teodoro Laino [tlaino] - University of Zurich - 03.2008
49! **************************************************************************************************
50 SUBROUTINE cp_cell_opt(force_env, globenv)
51 TYPE(force_env_type), POINTER :: force_env
52 TYPE(global_environment_type), POINTER :: globenv
53
54 CHARACTER(len=*), PARAMETER :: routinen = 'cp_cell_opt'
55
56 INTEGER :: handle, step_start_val
57 REAL(kind=dp), DIMENSION(:), POINTER :: x0
58 TYPE(cp_logger_type), POINTER :: logger
59 TYPE(gopt_f_type), POINTER :: gopt_env
60 TYPE(gopt_param_type), POINTER :: gopt_param
61 TYPE(section_vals_type), POINTER :: geo_section, root_section
62
63 CALL timeset(routinen, handle)
64 logger => cp_get_default_logger()
65 cpassert(ASSOCIATED(force_env))
66 cpassert(ASSOCIATED(globenv))
67 NULLIFY (gopt_param, gopt_env, x0)
68 root_section => force_env%root_section
69 geo_section => section_vals_get_subs_vals(root_section, "MOTION%CELL_OPT")
70
71 ALLOCATE (gopt_param)
72 CALL gopt_param_read(gopt_param, geo_section, type_id=default_cell_method_id)
73 CALL gopt_f_create(gopt_env, gopt_param, force_env=force_env, globenv=globenv, &
74 geo_opt_section=geo_section)
75 CALL gopt_f_create_x0(gopt_env, x0)
76
77 CALL section_vals_val_get(geo_section, "STEP_START_VAL", i_val=step_start_val)
78 CALL cp_add_iter_level(logger, "CELL_OPT")
79 CALL cp_iterate(logger%iter_info, iter_nr=step_start_val)
80 CALL gopt_dispatch_optimizer(force_env, globenv, gopt_param, gopt_env, &
81 geo_section, x0)
82 CALL cp_rm_iter_level(logger, "CELL_OPT")
83
84 ! Reset counter for next iteration
85 CALL section_vals_val_set(geo_section, "STEP_START_VAL", i_val=0)
86 DEALLOCATE (x0)
87 CALL gopt_f_release(gopt_env)
88 DEALLOCATE (gopt_param)
89 CALL timestop(handle)
90
91 END SUBROUTINE cp_cell_opt
92
93END MODULE cell_opt
performs CELL optimization
Definition cell_opt.F:13
subroutine, public cp_cell_opt(force_env, globenv)
Main driver to perform geometry optimization.
Definition cell_opt.F:51
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...
subroutine, public cp_add_iter_level(logger, level_name, n_rlevel_new)
Adds an iteration level.
subroutine, public cp_iterate(iteration_info, last, iter_nr, increment, iter_nr_out)
adds one to the actual iteration
subroutine, public cp_rm_iter_level(logger, level_name, n_rlevel_att)
Removes an iteration level.
Interface for the force calculations.
performs geometry optimization
Definition geo_opt.F:13
subroutine, public gopt_dispatch_optimizer(force_env, globenv, gopt_param, gopt_env, geo_section, x0)
dispatch to the selected optimizer (BFGS, L-BFGS or CG)
Definition geo_opt.F:169
Define type storing the global information of a run. Keep the amount of stored data small....
contains a functional that calculates the energy and its derivatives for the geometry optimizer
subroutine, public gopt_f_create_x0(gopt_env, x0)
returns the value of the parameters for the actual configuration
contains a functional that calculates the energy and its derivatives for the geometry optimizer
recursive subroutine, public gopt_f_create(gopt_env, gopt_param, force_env, globenv, geo_opt_section, eval_opt_geo)
...
recursive subroutine, public gopt_f_release(gopt_env)
...
contains typo and related routines to handle parameters controlling the GEO_OPT module
subroutine, public gopt_param_read(gopt_param, gopt_section, type_id)
reads the parameters of the geopmetry optimizer
collects all constants needed in input so that they can be used without circular dependencies
integer, parameter, public default_cell_method_id
objects that represent the structure of input sections and the data contained in an input section
subroutine, public section_vals_val_set(section_vals, keyword_name, i_rep_section, i_rep_val, val, l_val, i_val, r_val, c_val, l_vals_ptr, i_vals_ptr, r_vals_ptr, c_vals_ptr)
sets the requested value
recursive type(section_vals_type) function, pointer, public section_vals_get_subs_vals(section_vals, subsection_name, i_rep_section, can_return_null)
returns the values of the requested subsection
subroutine, public section_vals_val_get(section_vals, keyword_name, i_rep_section, i_rep_val, n_rep_val, val, l_val, i_val, r_val, c_val, l_vals, i_vals, r_vals, c_vals, explicit)
returns the requested value
Defines the basic variable types.
Definition kinds.F:23
integer, parameter, public dp
Definition kinds.F:34
type of a logger, at the moment it contains just a print level starting at which level it should be l...
wrapper to abstract the force evaluation of the various methods
contains the initially parsed file and the initial parallel environment
calculates the potential energy of a system, and its derivatives