/
input_cp2k_thermostats.F
804 lines (675 loc) · 41.7 KB
/
input_cp2k_thermostats.F
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
!--------------------------------------------------------------------------------------------------!
! CP2K: A general program to perform molecular dynamics simulations !
! Copyright 2000-2024 CP2K developers group <https://cp2k.org> !
! !
! SPDX-License-Identifier: GPL-2.0-or-later !
!--------------------------------------------------------------------------------------------------!
! **************************************************************************************************
!> \par History
!> 10.2005 split input_cp2k into smaller modules [fawzi]
!> \author teo & fawzi
! **************************************************************************************************
MODULE input_cp2k_thermostats
USE bibliography, ONLY: Bussi2007,&
Ceriotti2009,&
Ceriotti2009b,&
Jones2011,&
Nose1984a,&
Nose1984b
USE cp_output_handling, ONLY: cp_print_key_section_create,&
high_print_level,&
low_print_level
USE cp_units, ONLY: cp_unit_to_cp2k
USE input_constants, ONLY: &
do_constr_atomic, do_constr_molec, do_constr_none, do_region_defined, do_region_global, &
do_region_massive, do_region_molecule, do_region_none, do_thermo_al, do_thermo_csvr, &
do_thermo_gle, do_thermo_nose, do_thermo_same_as_part
USE input_cp2k_subsys, ONLY: create_rng_section
USE input_keyword_types, ONLY: keyword_create,&
keyword_release,&
keyword_type
USE input_section_types, ONLY: section_add_keyword,&
section_add_subsection,&
section_create,&
section_release,&
section_type
USE input_val_types, ONLY: char_t,&
integer_t,&
real_t
USE kinds, ONLY: dp
USE string_utilities, ONLY: s2a
#include "./base/base_uses.f90"
IMPLICIT NONE
PRIVATE
LOGICAL, PRIVATE, PARAMETER :: debug_this_module = .TRUE.
CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'input_cp2k_thermostats'
PUBLIC :: create_thermostat_section, &
create_thermo_fast_section, &
create_thermo_slow_section, &
create_coord_section, &
create_region_section, &
create_velocity_section, &
create_mass_section, &
create_gle_section
!***
CONTAINS
! **************************************************************************************************
!> \brief Specifies parameter for thermostat for constant temperature ensembles
!> \param section will contain the coeff section
!> \param coupled_thermostat ...
!> \author teo [tlaino] - University of Zurich - 09.2007
! **************************************************************************************************
SUBROUTINE create_thermo_slow_section(section, coupled_thermostat)
TYPE(section_type), POINTER :: section
LOGICAL, INTENT(IN), OPTIONAL :: coupled_thermostat
LOGICAL :: my_coupled_thermostat
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: nose_section, region_section
CPASSERT(.NOT. ASSOCIATED(section))
my_coupled_thermostat = .FALSE.
IF (PRESENT(coupled_thermostat)) my_coupled_thermostat = coupled_thermostat
NULLIFY (nose_section, region_section)
CALL section_create(section, __LOCATION__, name="THERMOSTAT_SLOW", &
description="Specify thermostat type and parameters controlling the thermostat.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
IF (.NOT. my_coupled_thermostat) THEN
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_nose, &
enum_c_vals=s2a("NOSE"), &
enum_i_vals=(/do_thermo_nose/), &
enum_desc=s2a("Uses only the Nose-Hoover thermostat."))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="REGION", &
description="Determines the defined region for slow thermostat", &
usage="REGION (GLOBAL||MOLECULE||MASSIVE||DEFINED||NONE)", &
enum_c_vals=s2a("GLOBAL", "MOLECULE", "MASSIVE", "DEFINED", "NONE"), &
enum_i_vals=(/do_region_global, do_region_molecule, &
do_region_massive, do_region_defined, do_region_none/), &
default_i_val=do_region_global)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_region_section(region_section, "slow thermostat")
CALL section_add_subsection(section, region_section)
CALL section_release(region_section)
ELSE
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_same_as_part, &
enum_c_vals=s2a("SAME_AS_PARTICLE", "NOSE", "CSVR"), &
enum_i_vals=(/do_thermo_same_as_part, do_thermo_nose, do_thermo_csvr/), &
enum_desc=s2a("Use the same kind of thermostat used for particles.", &
"Uses the Nose-Hoover thermostat.", &
"Uses the canonical sampling through velocity rescaling."))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END IF
CALL create_nose_section(nose_section)
CALL section_add_subsection(section, nose_section)
CALL section_release(nose_section)
! Print Section
! CALL create_print_section(subsection)
! CALL section_add_subsection(section, subsection)
! CALL section_release(subsection)
END SUBROUTINE create_thermo_slow_section
! **************************************************************************************************
!> \brief Specifies parameter for thermostat for constant temperature ensembles
!> \param section will contain the coeff section
!> \param coupled_thermostat ...
!> \author teo [tlaino] - University of Zurich - 09.2007
! **************************************************************************************************
SUBROUTINE create_thermo_fast_section(section, coupled_thermostat)
TYPE(section_type), POINTER :: section
LOGICAL, INTENT(IN), OPTIONAL :: coupled_thermostat
LOGICAL :: my_coupled_thermostat
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: nose_section, region_section
CPASSERT(.NOT. ASSOCIATED(section))
my_coupled_thermostat = .FALSE.
IF (PRESENT(coupled_thermostat)) my_coupled_thermostat = coupled_thermostat
NULLIFY (nose_section, region_section)
CALL section_create(section, __LOCATION__, name="THERMOSTAT_FAST", &
description="Specify thermostat type and parameters controlling the thermostat.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
IF (.NOT. my_coupled_thermostat) THEN
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_nose, &
enum_c_vals=s2a("NOSE"), &
enum_i_vals=(/do_thermo_nose/), &
enum_desc=s2a("Uses only the Nose-Hoover thermostat."))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="REGION", &
description="Determines the defined region for fast thermostat", &
usage="REGION (GLOBAL||MOLECULE||MASSIVE||DEFINED||NONE)", &
enum_c_vals=s2a("GLOBAL", "MOLECULE", "MASSIVE", "DEFINED", "NONE"), &
enum_i_vals=(/do_region_global, do_region_molecule, &
do_region_massive, do_region_defined, do_region_none/), &
default_i_val=do_region_global)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_region_section(region_section, "fast thermostat")
CALL section_add_subsection(section, region_section)
CALL section_release(region_section)
ELSE
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_same_as_part, &
enum_c_vals=s2a("SAME_AS_PARTICLE", "NOSE", "CSVR"), &
enum_i_vals=(/do_thermo_same_as_part, do_thermo_nose, do_thermo_csvr/), &
enum_desc=s2a("Use the same kind of thermostat used for particles.", &
"Uses the Nose-Hoover thermostat.", &
"Uses the canonical sampling through velocity rescaling."))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END IF
CALL create_nose_section(nose_section)
CALL section_add_subsection(section, nose_section)
CALL section_release(nose_section)
! Print Section
! CALL create_print_section(subsection)
! CALL section_add_subsection(section, subsection)
! CALL section_release(subsection)
END SUBROUTINE create_thermo_fast_section
! **************************************************************************************************
!> \brief Specifies parameter for thermostat for constant temperature ensembles
!> \param section will contain the coeff section
!> \param coupled_thermostat ...
!> \author teo [tlaino] - University of Zurich - 09.2007
! **************************************************************************************************
SUBROUTINE create_thermostat_section(section, coupled_thermostat)
TYPE(section_type), POINTER :: section
LOGICAL, INTENT(IN), OPTIONAL :: coupled_thermostat
LOGICAL :: my_coupled_thermostat
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: al_section, csvr_section, gle_section, &
nose_section, region_section, &
subsection
CPASSERT(.NOT. ASSOCIATED(section))
my_coupled_thermostat = .FALSE.
IF (PRESENT(coupled_thermostat)) my_coupled_thermostat = coupled_thermostat
NULLIFY (csvr_section, gle_section, al_section, nose_section, subsection, region_section)
CALL section_create(section, __LOCATION__, name="THERMOSTAT", &
description="Specify thermostat type and parameters controlling the thermostat.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
IF (.NOT. my_coupled_thermostat) THEN
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_nose, &
enum_c_vals=s2a("NOSE", "CSVR", "GLE", "AD_LANGEVIN"), &
enum_i_vals=(/do_thermo_nose, &
do_thermo_csvr, do_thermo_gle, do_thermo_al/), &
enum_desc=s2a("Uses the Nose-Hoover thermostat.", &
"Uses the canonical sampling through velocity rescaling.", &
"Uses GLE thermostat", &
"Uses adaptive-Langevin thermostat"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="REGION", &
description="Determines the region each thermostat is attached to.", &
usage="REGION (GLOBAL||MOLECULE||MASSIVE||DEFINED||NONE)", &
enum_c_vals=s2a("GLOBAL", "MOLECULE", "MASSIVE", "DEFINED", "NONE"), &
enum_i_vals=(/do_region_global, do_region_molecule, &
do_region_massive, do_region_defined, do_region_none/), &
default_i_val=do_region_global)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_region_section(region_section, "thermostat")
CALL section_add_subsection(section, region_section)
CALL section_release(region_section)
ELSE
CALL keyword_create(keyword, __LOCATION__, name="TYPE", &
description="Specify the thermostat used for the constant temperature ensembles.", &
usage="thermostat NOSE", &
default_i_val=do_thermo_same_as_part, &
enum_c_vals=s2a("SAME_AS_PARTICLE", "NOSE", "CSVR"), &
enum_i_vals=(/do_thermo_same_as_part, do_thermo_nose, do_thermo_csvr/), &
enum_desc=s2a("Use the same kind of thermostat used for particles.", &
"Uses the Nose-Hoover thermostat.", &
"Uses the canonical sampling through velocity rescaling."))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END IF
CALL create_nose_section(nose_section)
CALL section_add_subsection(section, nose_section)
CALL section_release(nose_section)
CALL create_csvr_section(csvr_section)
CALL section_add_subsection(section, csvr_section)
CALL section_release(csvr_section)
CALL create_gle_section(gle_section)
CALL section_add_subsection(section, gle_section)
CALL section_release(gle_section)
CALL create_al_section(al_section)
CALL section_add_subsection(section, al_section)
CALL section_release(al_section)
! Print Section
CALL create_print_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_thermostat_section
! **************************************************************************************************
!> \brief Creates print section for thermostat section
!> \param section ...
!> \author teo [tlaino] - University of Zurich - 02.2008
! **************************************************************************************************
SUBROUTINE create_print_section(section)
TYPE(section_type), POINTER :: section
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
NULLIFY (print_key)
CALL section_create(section, __LOCATION__, name="PRINT", &
description="Collects all print_keys for thermostat", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
CALL cp_print_key_section_create(print_key, __LOCATION__, "THERMOSTAT_INFO", &
description="Controls output information of the corresponding thermostat.", &
print_level=low_print_level, common_iter_levels=1, &
filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, __LOCATION__, "TEMPERATURE", &
description="Controls the output of the temperatures of the regions corresponding to "// &
"the present thermostat", &
print_level=high_print_level, common_iter_levels=1, &
filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, __LOCATION__, "ENERGY", &
description="Controls the output of kinetic energy, and potential energy "// &
"of the defined thermostat.", print_level=high_print_level, common_iter_levels=1, &
filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_section
! **************************************************************************************************
!> \brief Creates a section to arbitrary define a region to thermostat
!> \param section will contain the coeff section
!> \param label ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_region_section(section, label)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), INTENT(IN) :: label
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="DEFINE_REGION", &
description="This section provides the possibility to define arbitrary region "// &
"for the "//TRIM(label)//".", &
n_keywords=1, n_subsections=0, repeats=.TRUE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="LIST", &
description="Specifies a list of atoms to thermostat.", &
usage="LIST {integer} {integer} .. {integer}", repeats=.TRUE., &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="MOLNAME", &
variants=(/"SEGNAME"/), &
description="Specifies the name of the molecules to thermostat", &
usage="MOLNAME WAT MEOH", repeats=.TRUE., &
n_var=-1, type_of_var=char_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="MM_SUBSYS", &
variants=(/"PROTEIN"/), &
description="In a QM/MM run all MM atoms are specified as a whole ensemble to be thermostated", &
usage="MM_SUBSYS (NONE|ATOMIC|MOLECULAR)", &
enum_c_vals=s2a("NONE", "ATOMIC", "MOLECULAR"), &
enum_i_vals=(/do_constr_none, do_constr_atomic, do_constr_molec/), &
enum_desc=s2a("Thermostat nothing", &
"Only the MM atoms itself", &
"The full molecule/residue that contains a MM atom"), &
default_i_val=do_constr_none, repeats=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="QM_SUBSYS", &
description="In a QM/MM run all QM atoms are specified as a whole ensemble to be thermostated", &
usage="QM_SUBSYS (NONE|ATOMIC|MOLECULAR)", &
enum_c_vals=s2a("NONE", "ATOMIC", "MOLECULAR"), &
enum_desc=s2a("Thermostat nothing", &
"Only the QM atoms itself", &
"The full molecule/residue that contains a QM atom"), &
enum_i_vals=(/do_constr_none, do_constr_atomic, do_constr_molec/), &
default_i_val=do_constr_none, repeats=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_region_section
! **************************************************************************************************
!> \brief ...
!> \param section will contain the ewald section
!> \author gloria
! **************************************************************************************************
SUBROUTINE create_nose_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="nose", &
description="paramameters of the Nose Hoover thermostat chain", &
citations=(/Nose1984a, Nose1984b/))
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, __LOCATION__, name="length", &
description="length of the Nose-Hoover chain", usage="length integer", &
default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="Yoshida", &
description="order of the yoshida integrator used for the thermostat", &
usage="Yoshida integer", &
default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="timecon", &
description="timeconstant of the thermostat chain", &
usage="timecon <REAL>", &
default_r_val=cp_unit_to_cp2k(1000.0_dp, "fs"), &
unit_str="fs")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="mts", &
variants=s2a("multiple_time_steps", "mult_t_steps"), &
description="number of multiple timesteps to be used for the NoseHoover chain", &
usage="mts integer", &
default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_coord_section(subsection, "NOSE HOOVER")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_velocity_section(subsection, "NOSE HOOVER")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_mass_section(subsection, "NOSE HOOVER")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_force_section(subsection, "NOSE HOOVER")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_nose_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
!> \param
!> \author
! **************************************************************************************************
SUBROUTINE create_gle_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="GLE", &
description="paramameters of the gle thermostat. This section can be generated "// &
"from <https://gle4md.org/index.html?page=matrix>.", &
citations=(/Ceriotti2009, Ceriotti2009b/))
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, __LOCATION__, name="NDIM", &
description="Size of the gle matrix", usage="NDIM 6", &
default_i_val=5)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="A_SCALE", &
description="scaling factor for matrix A (for generic matrix A, depends "// &
"on the characteristic frequency of the system).", usage="A_SCALE 0.5", &
default_r_val=cp_unit_to_cp2k(1.0_dp, "ps^-1"), unit_str="ps^-1")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="A_LIST", &
description="A matrix The defaults give optimal sampling for most "// &
"cristalline and liquid compounds. Generated with the parameters set kv_4-4.a "// &
"centered on w_0=40 cm^-1.", usage="A_LIST real real real", &
type_of_var=real_t, unit_str="internal_cp2k", &
n_var=-1, repeats=.TRUE.)
! default_r_vals=(/ &
! 1.859575861256e+2_dp, 2.726385349840e-1_dp, 1.152610045461e+1_dp, -3.641457826260e+1_dp, 2.317337581602e+2_dp, &
! -2.780952471206e-1_dp, 8.595159180871e-5_dp, 7.218904801765e-1_dp, -1.984453934386e-1_dp, 4.240925758342e-1_dp, &
! -1.482580813121e+1_dp, -7.218904801765e-1_dp, 1.359090212128e+0_dp, 5.149889628035e+0_dp, -9.994926845099e+0_dp, &
! -1.037218912688e+1_dp, 1.984453934386e-1_dp, -5.149889628035e+0_dp, 2.666191089117e+1_dp, 1.150771549531e+1_dp, &
! 2.180134636042e+2_dp, -4.240925758342e-1_dp, 9.994926845099e+0_dp, -1.150771549531e+1_dp, 3.095839456559e+2_dp /), &
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="C_LIST", &
description="C matrix", usage="C_LIST real real real", &
unit_str="K_e", &
type_of_var=real_t, n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_thermo_energy_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_rng_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_gles_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_gle_section
! **************************************************************************************************
!> \brief Creates the gles section
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_gles_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="s", &
description="The s variable for GLE used for restart", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify s variable for GLE thermostat ", repeats=.FALSE., &
usage="{Real} ...", type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_gles_section
! **************************************************************************************************
!> \brief ...
!> \param section will contain the ewald section
!> \author teo [tlaino] - University of Zurich - 09.2007
! **************************************************************************************************
SUBROUTINE create_csvr_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="csvr", &
description="Parameters of the canonical sampling through velocity rescaling thermostat.", &
citations=(/Bussi2007/))
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, __LOCATION__, name="timecon", &
description="Time constant of the CSVR thermostat. A small time "// &
"constant will result in strong thermostatting (useful for "// &
"initial equilibrations) and a large time constant would be adequate "// &
"to get weak thermostatting in production runs.", &
usage="timecon <REAL>", &
default_r_val=cp_unit_to_cp2k(1000.0_dp, "fs"), &
unit_str="fs")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_thermo_energy_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_rng_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_csvr_section
! **************************************************************************************************
!> \brief ...
!> \param section will contain the adaptive langevin section
!> \author Noam [bernstei]
! **************************************************************************************************
SUBROUTINE create_al_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="ad_langevin", &
description="Parameters of the adaptive-Langevin thermostat."// &
" Known to work with NVT ensemble, but not tested with"// &
" other ensembles. Also tested with FIXED_ATOMS constraints, but"// &
" may not work with other constraints (restraints should be OK, but"// &
" haven't been well tested)", &
citations=(/Jones2011/))
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, __LOCATION__, name="timecon_nh", &
description="Time constant of the Nose-Hoover part of the AD_LANGEVIN thermostat. A small time "// &
"constant will result in strong thermostatting (useful for "// &
"initial equilibrations) and a large time constant would be adequate "// &
"to get weak thermostatting in production runs.", &
usage="timecon_nh <REAL>", &
default_r_val=cp_unit_to_cp2k(1000.0_dp, "fs"), &
unit_str="fs")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, __LOCATION__, name="timecon_langevin", &
description="Time constant of the Langevin part of the AD_LANGEVIN thermostat. A small time "// &
"constant will result in strong thermostatting (useful for "// &
"initial equilibrations) and a large time constant would be adequate "// &
"to get weak thermostatting in production runs.", &
usage="timecon_langevin <REAL>", &
default_r_val=cp_unit_to_cp2k(1000.0_dp, "fs"), &
unit_str="fs")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_thermo_chi_mass_section(subsection, "CHI")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_thermo_chi_mass_section(subsection, "MASS")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_al_section
! **************************************************************************************************
!> \brief Creates the thermostat chi restarting section
!> \param section the section to create
!> \param sec_name ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_thermo_chi_mass_section(section, sec_name)
TYPE(section_type), POINTER :: section
CHARACTER(len=*) :: sec_name
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name=TRIM(sec_name), &
description="Information to initialize the Ad-Langevin thermostat DOF "//TRIM(sec_name), &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify an initial thermostat DOF "//TRIM(sec_name)// &
" for Ad-Langevin thermostat.", repeats=.TRUE., &
unit_str="fs^-1", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_thermo_chi_mass_section
! **************************************************************************************************
!> \brief Creates the thermostat energy restarting section
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_thermo_energy_section(section)
TYPE(section_type), POINTER :: section
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="THERMOSTAT_ENERGY", &
description="Information to initialize the CSVR thermostat energy.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify an initial thermostat energy for CSVR thermostat.", &
repeats=.TRUE., unit_str="internal_cp2k", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_thermo_energy_section
! **************************************************************************************************
!> \brief Creates the mass section
!> \param section the section to create
!> \param name ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_force_section(section, name)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="force", &
description="The forces for "//TRIM(name)//" used for restart", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify masses of the system", repeats=.FALSE., &
usage="{Real} ...", type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_force_section
! **************************************************************************************************
!> \brief Creates the mass section
!> \param section the section to create
!> \param name ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_mass_section(section, name)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="mass", &
description="The masses for "//TRIM(name)//" used for restart", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify masses of the system", repeats=.FALSE., &
usage="{Real} ...", type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_mass_section
! **************************************************************************************************
!> \brief Creates the velocity section
!> \param section the section to create
!> \param name ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_velocity_section(section, name)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="velocity", &
description="The velocities for "//TRIM(name)//" used for restart", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify velocities of the system", repeats=.TRUE., &
usage="{Real} ...", type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_velocity_section
! **************************************************************************************************
!> \brief Creates the coord section
!> \param section the section to create
!> \param name ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_coord_section(section, name)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, __LOCATION__, name="coord", &
description="The positions for "//TRIM(name)//" used for restart", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, __LOCATION__, name="_DEFAULT_KEYWORD_", &
description="Specify positions of the system", repeats=.TRUE., &
usage="{Real} ...", type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_coord_section
END MODULE input_cp2k_thermostats