Line data Source code
1 : !--------------------------------------------------------------------------------------------------!
2 : ! CP2K: A general program to perform molecular dynamics simulations !
3 : ! Copyright 2000-2025 CP2K developers group <https://cp2k.org> !
4 : ! !
5 : ! SPDX-License-Identifier: GPL-2.0-or-later !
6 : !--------------------------------------------------------------------------------------------------!
7 :
8 : ! **************************************************************************************************
9 : !> \par History
10 : !> - taken out of input_cp2k_motion
11 : !> \author Ole Schuett
12 : ! **************************************************************************************************
13 : MODULE input_cp2k_motion_print
14 : USE cp_output_handling, ONLY: add_last_numeric,&
15 : cp_print_key_section_create,&
16 : high_print_level,&
17 : low_print_level,&
18 : silent_print_level
19 : USE input_constants, ONLY: dump_atomic,&
20 : dump_dcd,&
21 : dump_dcd_aligned_cell,&
22 : dump_extxyz,&
23 : dump_pdb,&
24 : dump_xmol
25 : USE input_cp2k_subsys, ONLY: create_structure_data_section
26 : USE input_keyword_types, ONLY: keyword_create,&
27 : keyword_release,&
28 : keyword_type
29 : USE input_section_types, ONLY: section_add_keyword,&
30 : section_add_subsection,&
31 : section_create,&
32 : section_release,&
33 : section_type
34 : USE string_utilities, ONLY: s2a
35 : #include "./base/base_uses.f90"
36 :
37 : IMPLICIT NONE
38 : PRIVATE
39 :
40 : LOGICAL, PRIVATE, PARAMETER :: debug_this_module = .TRUE.
41 : CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'input_cp2k_motion_print'
42 :
43 : PUBLIC :: create_motion_print_section, add_format_keyword
44 :
45 : CONTAINS
46 :
47 : ! **************************************************************************************************
48 : !> \brief creates the motion%print section
49 : !> \param section the section to be created
50 : !> \author teo
51 : ! **************************************************************************************************
52 9288 : SUBROUTINE create_motion_print_section(section)
53 : TYPE(section_type), POINTER :: section
54 :
55 : TYPE(keyword_type), POINTER :: keyword
56 : TYPE(section_type), POINTER :: print_key
57 :
58 9288 : NULLIFY (keyword, section, print_key)
59 :
60 : CALL section_create(section, __LOCATION__, name="print", &
61 : description="Controls the printing properties during an MD/Optimization run", &
62 9288 : n_keywords=1, n_subsections=1, repeats=.TRUE.)
63 :
64 : CALL keyword_create(keyword, __LOCATION__, name="MEMORY_INFO", &
65 : variants=["MEMORY"], &
66 : description="Whether overall memory usage should be sampled and printed "// &
67 : "at each MD/Optimization step.", &
68 : usage="MEMORY_INFO LOGICAL", &
69 18576 : default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
70 9288 : CALL section_add_keyword(section, keyword)
71 9288 : CALL keyword_release(keyword)
72 :
73 : CALL cp_print_key_section_create(print_key, __LOCATION__, "TRAJECTORY", &
74 : description="Controls the output of the trajectory", &
75 : print_level=low_print_level, common_iter_levels=1, &
76 9288 : filename="", unit_str="angstrom")
77 : CALL add_format_keyword(keyword, print_key, pos=.TRUE., &
78 9288 : description="Specifies the format of the output file for the trajectory.")
79 9288 : CALL section_add_subsection(section, print_key)
80 9288 : CALL section_release(print_key)
81 :
82 : CALL cp_print_key_section_create( &
83 : print_key, __LOCATION__, "SHELL_TRAJECTORY", &
84 : description="Controls the output of the trajectory of shells when the shell-model is used ", &
85 : print_level=high_print_level, common_iter_levels=1, &
86 9288 : filename="", unit_str="angstrom")
87 : CALL add_format_keyword(keyword, print_key, pos=.TRUE., &
88 9288 : description="Specifies the format of the output file for the trajectory of shells.")
89 9288 : CALL section_add_subsection(section, print_key)
90 9288 : CALL section_release(print_key)
91 :
92 : CALL cp_print_key_section_create(print_key, __LOCATION__, "CORE_TRAJECTORY", &
93 : description="Controls the output of the trajectory of cores when the shell-model is used ", &
94 : print_level=high_print_level, common_iter_levels=1, &
95 9288 : filename="", unit_str="angstrom")
96 : CALL add_format_keyword(keyword, print_key, pos=.TRUE., &
97 9288 : description="Specifies the format of the output file for the trajectory of cores.")
98 9288 : CALL section_add_subsection(section, print_key)
99 9288 : CALL section_release(print_key)
100 :
101 : CALL cp_print_key_section_create(print_key, __LOCATION__, "CELL", &
102 : description="Controls the output of the simulation cell. "// &
103 : "For later analysis of the trajectory it is recommendable that the "// &
104 : "frequency of printing is the same as the one used for the trajectory file.", &
105 : print_level=high_print_level, common_iter_levels=1, &
106 9288 : filename="")
107 9288 : CALL section_add_subsection(section, print_key)
108 9288 : CALL section_release(print_key)
109 :
110 : CALL cp_print_key_section_create(print_key, __LOCATION__, "VELOCITIES", &
111 : description="Controls the output of the atomic velocities. "// &
112 : "The default unit for the atomic velocities $v$ is bohr/au_time. "// &
113 : "The kinetic energy $K_i$ in [hartree] of an atom $i$ with mass $m_i$ in "// &
114 : "atomic mass units [amu] (or just [u]) and velocity $v_i$ can be obtained by "// &
115 : "$K_i = \frac{1}{2}f_u\,m_i\,v_i^2$ with $f_u = 1822.888$ as conversion factor "// &
116 : "from [u] to [a.u.]. $f_u$ is printed in full precision in the top of the CP2K "// &
117 : "output for print level MEDIUM or higher.", &
118 : print_level=high_print_level, common_iter_levels=1, &
119 9288 : filename="", unit_str="bohr*au_t^-1")
120 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
121 9288 : description="Specifies the format of the output file for the velocities.")
122 9288 : CALL section_add_subsection(section, print_key)
123 9288 : CALL section_release(print_key)
124 :
125 : CALL cp_print_key_section_create(print_key, __LOCATION__, "SHELL_VELOCITIES", &
126 : description="Controls the output of the velocities of shells when the shell model is used", &
127 : print_level=high_print_level, common_iter_levels=1, &
128 9288 : filename="", unit_str="bohr*au_t^-1")
129 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
130 9288 : description="Specifies the format of the output file for the velocities of shells.")
131 9288 : CALL section_add_subsection(section, print_key)
132 9288 : CALL section_release(print_key)
133 :
134 : CALL cp_print_key_section_create(print_key, __LOCATION__, "CORE_VELOCITIES", &
135 : description="controls the output of the velocities of cores when the shell model is used", &
136 : print_level=high_print_level, common_iter_levels=1, &
137 9288 : filename="", unit_str="bohr*au_t^-1")
138 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
139 9288 : description="Specifies the format of the output file for the velocities of cores.")
140 9288 : CALL section_add_subsection(section, print_key)
141 9288 : CALL section_release(print_key)
142 :
143 9288 : CALL create_structure_data_section(print_key)
144 9288 : CALL section_add_subsection(section, print_key)
145 9288 : CALL section_release(print_key)
146 :
147 : CALL cp_print_key_section_create( &
148 : print_key, __LOCATION__, "FORCE_MIXING_LABELS", &
149 : description="Controls the output of the force mixing (FORCE_EVAL&QMMM&FORCE_MIXING) labels", &
150 : print_level=high_print_level, common_iter_levels=1, &
151 9288 : filename="")
152 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
153 9288 : description="Specifies the format of the output file for the force mixing labels.")
154 9288 : CALL section_add_subsection(section, print_key)
155 9288 : CALL section_release(print_key)
156 :
157 : CALL cp_print_key_section_create(print_key, __LOCATION__, "FORCES", &
158 : description="Controls the output of the forces", &
159 : print_level=high_print_level, common_iter_levels=1, &
160 9288 : filename="", unit_str="hartree*bohr^-1")
161 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
162 9288 : description="Specifies the format of the output file for the forces.")
163 9288 : CALL section_add_subsection(section, print_key)
164 9288 : CALL section_release(print_key)
165 :
166 : CALL cp_print_key_section_create(print_key, __LOCATION__, "SHELL_FORCES", &
167 : description="Controls the output of the forces on shells when shell-model is used", &
168 : print_level=high_print_level, common_iter_levels=1, &
169 9288 : filename="", unit_str="hartree*bohr^-1")
170 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
171 9288 : description="Specifies the format of the output file for the forces on shells.")
172 9288 : CALL section_add_subsection(section, print_key)
173 9288 : CALL section_release(print_key)
174 :
175 : CALL cp_print_key_section_create(print_key, __LOCATION__, "CORE_FORCES", &
176 : description="Controls the output of the forces on cores when shell-model is used", &
177 : print_level=high_print_level, common_iter_levels=1, &
178 9288 : filename="", unit_str="hartree*bohr^-1")
179 : CALL add_format_keyword(keyword, print_key, pos=.FALSE., &
180 9288 : description="Specifies the format of the output file for the forces on cores.")
181 9288 : CALL section_add_subsection(section, print_key)
182 9288 : CALL section_release(print_key)
183 :
184 : CALL cp_print_key_section_create(print_key, __LOCATION__, "MIXED_ENERGIES", &
185 : description="Controls the output of the energies of the two "// &
186 : "regular FORCE_EVALS in the MIXED method "// &
187 : "printed is step,time,Etot,E_F1,E_F2,CONS_QNT", &
188 : print_level=low_print_level, common_iter_levels=1, &
189 9288 : filename="")
190 9288 : CALL section_add_subsection(section, print_key)
191 9288 : CALL section_release(print_key)
192 :
193 : CALL cp_print_key_section_create(print_key, __LOCATION__, "STRESS", &
194 : description="Controls the output of the stress tensor", &
195 : print_level=high_print_level, common_iter_levels=1, &
196 9288 : filename="")
197 9288 : CALL section_add_subsection(section, print_key)
198 9288 : CALL section_release(print_key)
199 :
200 : CALL cp_print_key_section_create(print_key, __LOCATION__, "POLAR_MATRIX", &
201 : description="Controls the output of the polarisability tensor during an MD run", &
202 : print_level=low_print_level, common_iter_levels=1, &
203 9288 : filename="")
204 9288 : CALL section_add_subsection(section, print_key)
205 9288 : CALL section_release(print_key)
206 :
207 : CALL cp_print_key_section_create(print_key, __LOCATION__, "RESTART", &
208 : description="Controls the dumping of the restart file during runs. "// &
209 : "By default keeps a short history of three restarts. See also RESTART_HISTORY", &
210 : each_iter_names=s2a("MD"), each_iter_values=[20], &
211 : print_level=silent_print_level, common_iter_levels=1, &
212 9288 : add_last=add_last_numeric, filename="")
213 :
214 : CALL keyword_create(keyword, __LOCATION__, name="BACKUP_COPIES", &
215 : description="Specifies the maximum number of backup copies.", &
216 : usage="BACKUP_COPIES {int}", &
217 9288 : default_i_val=1)
218 9288 : CALL section_add_keyword(print_key, keyword)
219 9288 : CALL keyword_release(keyword)
220 :
221 : CALL keyword_create(keyword, __LOCATION__, name="SPLIT_RESTART_FILE", &
222 : description="If specified selected input sections, which are growing with the "// &
223 : "number of atoms in the system, are written to another restart file "// &
224 : "in binary format instead of the default restart file in human "// &
225 : "readable ASCII format. This split of the restart file may "// &
226 : "provide significant memory savings and an accelerated I/O for "// &
227 : "systems with a very large number of atoms", &
228 : usage="SPLIT_RESTART_FILE yes", &
229 : default_l_val=.FALSE., &
230 9288 : lone_keyword_l_val=.TRUE.)
231 9288 : CALL section_add_keyword(print_key, keyword)
232 9288 : CALL keyword_release(keyword)
233 :
234 9288 : CALL section_add_subsection(section, print_key)
235 9288 : CALL section_release(print_key)
236 :
237 : CALL cp_print_key_section_create(print_key, __LOCATION__, "RESTART_HISTORY", &
238 : description="Dumps unique restart files during the run keeping all of them. "// &
239 : "Most useful if recovery is needed at a later point.", &
240 : print_level=low_print_level, common_iter_levels=0, &
241 : each_iter_names=s2a("MD", "GEO_OPT", "ROT_OPT"), each_iter_values=[500, 500, 500], &
242 9288 : filename="")
243 9288 : CALL section_add_subsection(section, print_key)
244 9288 : CALL section_release(print_key)
245 :
246 : CALL cp_print_key_section_create(print_key, __LOCATION__, "TRANSLATION_VECTOR", &
247 : description="Dumps the translation vector applied along an MD (if any). Useful"// &
248 : " for postprocessing of QMMM trajectories in which the QM fragment is continuously"// &
249 : " centered in the QM box", &
250 : print_level=high_print_level, common_iter_levels=1, &
251 9288 : filename="")
252 9288 : CALL section_add_subsection(section, print_key)
253 9288 : CALL section_release(print_key)
254 :
255 9288 : END SUBROUTINE create_motion_print_section
256 :
257 : ! **************************************************************************************************
258 : !> \brief creates the FORMAT keyword
259 : !> \param keyword ...
260 : !> \param section will contain the pint section
261 : !> \param pos ...
262 : !> \param description ...
263 : !> \author Teodoro Laino 10.2008 [tlaino]
264 : ! **************************************************************************************************
265 158022 : SUBROUTINE add_format_keyword(keyword, section, pos, description)
266 : TYPE(keyword_type), POINTER :: keyword
267 : TYPE(section_type), POINTER :: section
268 : LOGICAL, INTENT(IN) :: pos
269 : CHARACTER(LEN=*), INTENT(IN) :: description
270 :
271 158022 : CPASSERT(ASSOCIATED(section))
272 158022 : CPASSERT(.NOT. ASSOCIATED(keyword))
273 :
274 158022 : IF (pos) THEN
275 :
276 : CALL keyword_create( &
277 : keyword, __LOCATION__, name="FORMAT", &
278 : description=description, usage="FORMAT (ATOMIC|DCD|PDB|XMOL|XYZ|EXTXYZ)", &
279 : default_i_val=dump_xmol, &
280 : enum_c_vals=s2a("ATOMIC", "DCD", "DCD_ALIGNED_CELL", "PDB", "XMOL", "XYZ", "EXTXYZ"), &
281 : enum_i_vals=[dump_atomic, dump_dcd, dump_dcd_aligned_cell, dump_pdb, dump_xmol, dump_xmol, dump_extxyz], &
282 : enum_desc=s2a("Write only the coordinates X,Y,Z without element symbols to a formatted file", &
283 : "Write the coordinates (no element labels) and the cell information to a binary file", &
284 : "Like DCD, but the dumped coordinates refer to an aligned cell following the common convention: "// &
285 : "the cell vector **a** is aligned with the *x* axis and the cell vector **b** lies in "// &
286 : "the *xy* plane. This allows the reconstruction of scaled coordinates from the DCD data only.", &
287 : "Write the atomic information in PDB format to a formatted file", &
288 : "Mostly known as XYZ format, provides in a formatted file: element_symbol X Y Z", &
289 : "Alias name for XMOL", &
290 : "Extended XYZ format including cell information. "// &
291 : "For details see [ASE](https://ase-lib.org/ase/io/formatoptions.html#extxyz) "// &
292 83718 : "and [OVITO](https://www.ovito.org/manual/reference/file_formats/input/xyz.html)."))
293 83718 : CALL section_add_keyword(section, keyword)
294 83718 : CALL keyword_release(keyword)
295 :
296 : CALL keyword_create(keyword, __LOCATION__, name="CHARGE_OCCUP", &
297 : variants=["CHARGE_O"], &
298 : description="Write the MM charges to the OCCUP field of the PDB file", &
299 : usage="CHARGE_OCCUP logical", &
300 167436 : default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
301 83718 : CALL section_add_keyword(section, keyword)
302 83718 : CALL keyword_release(keyword)
303 :
304 : CALL keyword_create(keyword, __LOCATION__, name="CHARGE_BETA", &
305 : variants=["CHARGE_B"], &
306 : description="Write the MM charges to the BETA field of the PDB file", &
307 : usage="CHARGE_BETA logical", &
308 167436 : default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
309 83718 : CALL section_add_keyword(section, keyword)
310 83718 : CALL keyword_release(keyword)
311 :
312 : CALL keyword_create(keyword, __LOCATION__, name="CHARGE_EXTENDED", &
313 : description="Write the MM charges to the very last field of the PDB file (starting from column 81)", &
314 : usage="CHARGE_EXTENDED logical", &
315 83718 : default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
316 83718 : CALL section_add_keyword(section, keyword)
317 83718 : CALL keyword_release(keyword)
318 :
319 : ELSE
320 :
321 : CALL keyword_create(keyword, __LOCATION__, name="FORMAT", &
322 : description=description, usage="FORMAT (ATOMIC|DCD|XMOL|XYZ|EXTXYZ)", &
323 : default_i_val=dump_xmol, &
324 : enum_c_vals=s2a("ATOMIC", "DCD", "XMOL", "XYZ", "EXTXYZ"), &
325 : enum_i_vals=[dump_atomic, dump_dcd, dump_xmol, dump_xmol, dump_extxyz], &
326 : enum_desc=s2a("Write only the coordinates X,Y,Z without element symbols to a formatted file", &
327 : "Write the coordinates (no element labels) and the cell information to a binary file", &
328 : "Mostly known as XYZ format, provides in a formatted file: element_symbol X Y Z", &
329 : "Alias name for XMOL", &
330 : "Extended XYZ format including cell information. "// &
331 : "For details see [ASE](https://ase-lib.org/ase/io/formatoptions.html#extxyz) "// &
332 74304 : "and [OVITO](https://www.ovito.org/manual/reference/file_formats/input/xyz.html)."))
333 74304 : CALL section_add_keyword(section, keyword)
334 74304 : CALL keyword_release(keyword)
335 :
336 : END IF
337 :
338 : CALL keyword_create(keyword, __LOCATION__, name="PRINT_ATOM_KIND", &
339 : description="Write the atom kind given in the subsys section instead of the element symbol. "// &
340 : "Only valid for the XMOL and EXTXYZ format.", &
341 : usage="PRINT_ATOM_KIND logical", &
342 158022 : default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
343 158022 : CALL section_add_keyword(section, keyword)
344 158022 : CALL keyword_release(keyword)
345 :
346 158022 : END SUBROUTINE add_format_keyword
347 :
348 : END MODULE input_cp2k_motion_print
|
