(git:27c966b)
Loading...
Searching...
No Matches
ipi_driver.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 Driver mode - To communicate with i-PI Python wrapper
10!> \par History
11!> none
12!> \author Michele Ceriotti 03.2012
13! **************************************************************************************************
15 use, INTRINSIC :: ieee_arithmetic, only: ieee_is_finite
16 USE iso_c_binding, ONLY: c_char, &
17 c_double, &
18 c_int, &
19 c_loc, &
20 c_null_char, &
21 c_ptr
22 USE bibliography, ONLY: ceriotti2014, &
23 kapil2016, &
24 cite_reference
25 USE cell_methods, ONLY: cell_create, &
27 USE cell_types, ONLY: cell_release, &
31 USE cp_subsys_types, ONLY: cp_subsys_get, &
35 USE force_env_types, ONLY: force_env_get, &
41 USE kinds, ONLY: default_path_length, &
43 dp, &
44 int_4
48 USE mathlib, ONLY: det_3x3
49#ifndef __NO_SOCKETS
50 USE sockets_interface, ONLY: writebuffer, &
51 readbuffer, &
54 uwait
55#endif
56 USE virial_types, ONLY: virial_type
57#include "./base/base_uses.f90"
58
59 IMPLICIT NONE
60
61 PRIVATE
62
63 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'ipi_driver'
64
65 PUBLIC :: run_driver
66
67CONTAINS
68
69! **************************************************************************************************
70!> \brief ...
71!> \param force_env ...
72!> \param globenv ...
73!> \par History
74!> 12.2013 included in repository
75!> \author Ceriotti
76! **************************************************************************************************
77
78 SUBROUTINE run_driver(force_env, globenv)
79 TYPE(force_env_type), POINTER :: force_env
80 TYPE(global_environment_type), POINTER :: globenv
81
82 CHARACTER(len=*), PARAMETER :: routinen = 'run_driver'
83
84#ifdef __NO_SOCKETS
85 INTEGER :: handle
86 CALL timeset(routinen, handle)
87 cpabort("CP2K was compiled with the __NO_SOCKETS option!")
88 mark_used(globenv)
89 mark_used(force_env)
90#else
91 INTEGER, PARAMETER :: msglen = 12
92
93 CHARACTER(len=default_path_length) :: c_hostname, drv_hostname, drv_prefix
94 CHARACTER(LEN=default_string_length) :: header
95 INTEGER :: drv_port, handle, i_drv_unix, &
96 idir, ii, inet, ip, iwait, &
97 nat, output_unit, socket
98 TYPE(mp_request_type), DIMENSION(2) :: wait_req
99 INTEGER(KIND=int_4), POINTER :: wait_msg(:)
100 LOGICAL :: drv_unix, fwait, hasdata, &
101 ionode, should_stop
102 REAL(kind=dp) :: cellh(3, 3), cellih(3, 3), &
103 mxmat(9), pot, vir(3, 3)
104 REAL(kind=dp), ALLOCATABLE :: combuf(:)
105 TYPE(cell_type), POINTER :: cpcell
106 TYPE(mp_para_env_type), POINTER :: para_env
107 TYPE(cp_subsys_type), POINTER :: subsys
108 TYPE(section_vals_type), POINTER :: drv_section, motion_section
109 TYPE(virial_type), POINTER :: virial
110 REAL(kind=dp) :: sleeptime
111 INTEGER, DIMENSION(3) :: perd
112 TYPE(cell_type), POINTER :: oldcell
113
114 CALL timeset(routinen, handle)
115
116 CALL cite_reference(ceriotti2014)
117 CALL cite_reference(kapil2016)
118
119! server address parsing
120! buffers and temporaries for communication
121! access cp2k structures
122
123 cpassert(ASSOCIATED(force_env))
124 CALL force_env_get(force_env, para_env=para_env)
125
126 hasdata = .false.
127 ionode = para_env%is_source()
128
129 output_unit = cp_logger_get_default_io_unit()
130
131 ! reads driver parameters from input
132 motion_section => section_vals_get_subs_vals(force_env%root_section, "MOTION")
133 drv_section => section_vals_get_subs_vals(motion_section, "DRIVER")
134
135 CALL section_vals_val_get(drv_section, "HOST", c_val=drv_hostname)
136 CALL section_vals_val_get(drv_section, "PORT", i_val=drv_port)
137 CALL section_vals_val_get(drv_section, "UNIX", l_val=drv_unix)
138 CALL section_vals_val_get(drv_section, "PREFIX", c_val=drv_prefix)
139 CALL section_vals_val_get(drv_section, "SLEEP_TIME", r_val=sleeptime)
140 cpassert(sleeptime >= 0)
141
142 ! opens the socket
143 socket = 0
144 inet = 1
145 i_drv_unix = 1 ! a bit convoluted. socket.c uses a different convention...
146 IF (drv_unix) i_drv_unix = 0
147 IF (output_unit > 0) THEN
148 WRITE (output_unit, *) "@ i-PI DRIVER BEING LOADED"
149 WRITE (output_unit, *) "@ INPUT DATA: ", trim(drv_hostname), drv_port, drv_unix
150 END IF
151
152 IF (drv_unix) THEN
153 ! for UNIX sockets, HOST names the socket file which lives at
154 ! /tmp/<PREFIX>_<HOST> (PREFIX must match the peer's convention,
155 ! e.g. "ipi" for i-PI)
156 c_hostname = "/tmp/"//trim(drv_prefix)//"_"//trim(drv_hostname)//c_null_char
157 ELSE
158 c_hostname = trim(drv_hostname)//c_null_char
159 END IF
160 IF (ionode) CALL open_connect_socket(socket, i_drv_unix, drv_port, c_hostname)
161
162 NULLIFY (wait_msg)
163 ALLOCATE (wait_msg(1))
164 !now we have a socket, so we can initialize the CP2K environments.
165 NULLIFY (cpcell)
166 CALL cell_create(cpcell)
167 driver_loop: DO
168 ! do communication on master node only...
169 header = ""
170
171 CALL para_env%sync()
172
173 ! non-blocking sync to avoid useless CPU consumption
174 IF (ionode) THEN
175 CALL readbuffer(socket, header, msglen)
176 wait_msg = 0
177 DO iwait = 0, para_env%num_pe - 1
178 IF (iwait /= para_env%source) THEN
179 CALL para_env%send(msg=wait_msg, dest=iwait, tag=666)
180 END IF
181 END DO
182 ELSE
183 CALL para_env%irecv(msgout=wait_msg, source=para_env%source, &
184 tag=666, request=wait_req(2))
185 CALL mp_testany(wait_req(2:), flag=fwait)
186 DO WHILE (.NOT. fwait)
187 CALL mp_testany(wait_req(2:), flag=fwait)
188 CALL uwait(sleeptime)
189 END DO
190 END IF
191
192 CALL para_env%sync()
193
194 CALL para_env%bcast(header)
195
196 IF (output_unit > 0) WRITE (output_unit, *) " @ DRIVER MODE: Message from server: ", trim(header)
197 IF (trim(header) == "STATUS") THEN
198
199 CALL para_env%sync()
200 IF (ionode) THEN ! does not need init (well, maybe it should, just to check atom numbers and the like... )
201 IF (hasdata) THEN
202 CALL writebuffer(socket, "HAVEDATA ", msglen)
203 ELSE
204 CALL writebuffer(socket, "READY ", msglen)
205 END IF
206 END IF
207 CALL para_env%sync()
208 ELSE IF (trim(header) == "POSDATA") THEN
209 IF (hasdata) cpabort("@DRIVER MODE: POSDATA received before GETFORCE")
210 IF (ionode) THEN
211 CALL readbuffer(socket, mxmat, 9)
212 cellh = reshape(mxmat, [3, 3])
213 CALL readbuffer(socket, mxmat, 9)
214 cellih = reshape(mxmat, [3, 3])
215 CALL readbuffer(socket, nat)
216 cellh = transpose(cellh)
217 cellih = transpose(cellih)
218 END IF
219 CALL para_env%bcast(cellh)
220 CALL para_env%bcast(cellih)
221 CALL para_env%bcast(nat)
222 CALL force_env_get(force_env, subsys=subsys)
223 ! Check before allocating/reading: nat is supplied by the socket peer.
224 IF (nat <= 0 .OR. nat /= subsys%particles%n_els .OR. nat > huge(nat)/3) THEN
225 cpabort("@DRIVER MODE: Particle number mismatch between i-PI and CP2K input")
226 END IF
227 IF (.NOT. all(ieee_is_finite(cellh)) .OR. .NOT. all(ieee_is_finite(cellih))) THEN
228 cpabort("@DRIVER MODE: Non-finite cell received from i-PI")
229 END IF
230 IF (.NOT. ieee_is_finite(det_3x3(cellh)) .OR. det_3x3(cellh) <= 0.0_dp) THEN
231 cpabort("@DRIVER MODE: i-PI cell must be nonsingular and right-handed")
232 END IF
233 IF (.NOT. ALLOCATED(combuf)) ALLOCATE (combuf(3*nat))
234 IF (ionode) CALL readbuffer(socket, combuf, nat*3)
235 CALL para_env%bcast(combuf)
236
237 IF (.NOT. all(ieee_is_finite(combuf))) THEN
238 cpabort("@DRIVER MODE: Non-finite positions received from i-PI")
239 END IF
240 ii = 0
241 DO ip = 1, subsys%particles%n_els
242 DO idir = 1, 3
243 ii = ii + 1
244 subsys%particles%els(ip)%r(idir) = combuf(ii)
245 END DO
246 END DO
247 NULLIFY (oldcell)
248 CALL cp_subsys_get(subsys, cell=oldcell)
249 perd = oldcell%perd
250
251 CALL init_cell(cpcell, hmat=cellh, periodic=perd)
252 CALL cp_subsys_set(subsys, cell=cpcell)
253
254 CALL force_env_calc_energy_force(force_env, calc_force=.true.)
255
256 IF (output_unit > 0) WRITE (output_unit, *) " @ DRIVER MODE: Received positions "
257
258 combuf = 0
259 ii = 0
260 DO ip = 1, subsys%particles%n_els
261 DO idir = 1, 3
262 ii = ii + 1
263 combuf(ii) = subsys%particles%els(ip)%f(idir)
264 END DO
265 END DO
266 CALL force_env_get(force_env, potential_energy=pot)
267 CALL force_env_get(force_env, cell=cpcell)
268 CALL cp_subsys_get(subsys, virial=virial)
269 vir = transpose(virial%pv_virial)
270
271 CALL external_control(should_stop, "IPI", globenv=globenv)
272 IF (should_stop) EXIT driver_loop
273
274 hasdata = .true.
275 ELSE IF (trim(header) == "GETFORCE") THEN
276 IF (.NOT. hasdata) cpabort("@DRIVER MODE: GETFORCE received without POSDATA")
277 IF (output_unit > 0) WRITE (output_unit, *) " @ DRIVER MODE: Returning v,forces,stress "
278 IF (ionode) THEN
279 CALL writebuffer(socket, "FORCEREADY ", msglen)
280 CALL writebuffer(socket, pot)
281 CALL writebuffer(socket, nat)
282 CALL writebuffer(socket, combuf, 3*nat)
283 CALL writebuffer(socket, reshape(vir, [9]), 9)
284
285 ! i-pi can also receive an arbitrary string, that will be printed out to the "extra"
286 ! trajectory file. this is useful if you want to return additional information, e.g.
287 ! atomic charges, wannier centres, etc. one must return the number of characters, then
288 ! the string. here we just send back zero characters.
289 nat = 0
290 CALL writebuffer(socket, nat) ! writes out zero for the length of the "extra" field (not implemented yet!)
291 END IF
292 hasdata = .false.
293 ELSE IF (trim(header) == "EXIT") THEN
294 IF (output_unit > 0) WRITE (output_unit, *) " @DRIVER MODE: Socket disconnected, time to exit."
295 EXIT driver_loop
296 ELSE
297 cpabort("@DRIVER MODE: Unknown i-PI message: "//trim(header))
298 END IF
299 END DO driver_loop
300
301 ! clean up
302 IF (ionode) CALL close_socket(socket)
303 CALL cell_release(cpcell)
304 DEALLOCATE (wait_msg)
305#endif
306
307 CALL timestop(handle)
308
309 END SUBROUTINE run_driver
310END MODULE ipi_driver
collects all references to literature in CP2K as new algorithms / method are included from literature...
integer, save, public kapil2016
integer, save, public ceriotti2014
Handles all functions related to the CELL.
subroutine, public init_cell(cell, hmat, periodic)
Initialise/readjust a simulation cell after hmat has been changed.
subroutine, public cell_create(cell, hmat, periodic, tag)
allocates and initializes a cell
Handles all functions related to the CELL.
Definition cell_types.F:15
subroutine, public cell_release(cell)
releases the given cell (see doc/ReferenceCounting.html)
Definition cell_types.F:704
Routines to handle the external control of CP2K.
subroutine, public external_control(should_stop, flag, globenv, target_time, start_time, force_check)
External manipulations during a run : when the <PROJECT_NAME>.EXIT_$runtype command is sent the progr...
various routines to log and control the output. The idea is that decisions about where to log should ...
integer function, public cp_logger_get_default_io_unit(logger)
returns the unit nr for the ionode (-1 on all other processors) skips as well checks if the procs cal...
types that represent a subsys, i.e. a part of the system
subroutine, public cp_subsys_set(subsys, atomic_kinds, particles, local_particles, molecules, molecule_kinds, local_molecules, para_env, colvar_p, shell_particles, core_particles, gci, multipoles, results, cell, cell_ref, use_ref_cell)
sets various propreties of the subsys
subroutine, public cp_subsys_get(subsys, ref_count, atomic_kinds, atomic_kind_set, particles, particle_set, local_particles, molecules, molecule_set, molecule_kinds, molecule_kind_set, local_molecules, para_env, colvar_p, shell_particles, core_particles, gci, multipoles, natom, nparticle, ncore, nshell, nkind, atprop, virial, results, cell, cell_ref, use_ref_cell)
returns information about various attributes of the given subsys
Interface for the force calculations.
recursive subroutine, public force_env_calc_energy_force(force_env, calc_force, consistent_energies, skip_external_control, eval_energy_forces, require_consistent_energy_force, linres, calc_stress_tensor)
Interface routine for force and energy calculations.
Interface for the force calculations.
recursive subroutine, public force_env_get(force_env, in_use, fist_env, qs_env, meta_env, fp_env, subsys, para_env, potential_energy, additional_potential, kinetic_energy, harmonic_shell, kinetic_shell, cell, sub_force_env, qmmm_env, qmmmx_env, eip_env, pwdft_env, globenv, input, force_env_section, method_name_id, root_section, mixed_env, nnp_env, embed_env, ipi_env)
returns various attributes about the force environment
Define type storing the global information of a run. Keep the amount of stored data small....
objects that represent the structure of input sections and the data contained in an input section
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
Driver mode - To communicate with i-PI Python wrapper.
Definition ipi_driver.F:14
subroutine, public run_driver(force_env, globenv)
...
Definition ipi_driver.F:79
Defines the basic variable types.
Definition kinds.F:23
integer, parameter, public dp
Definition kinds.F:34
integer, parameter, public default_string_length
Definition kinds.F:57
integer, parameter, public default_path_length
Definition kinds.F:58
integer, parameter, public int_4
Definition kinds.F:51
Collection of simple mathematical functions and subroutines.
Definition mathlib.F:15
Interface to the message passing library MPI.
Implements UNIX and INET sockets.
Type defining parameters related to the simulation cell.
Definition cell_types.F:60
represents a system: atoms, molecules, their pos,vel,...
wrapper to abstract the force evaluation of the various methods
contains the initially parsed file and the initial parallel environment
stores all the informations relevant to an mpi environment