38#include "./base/base_uses.f90"
43 LOGICAL,
PRIVATE,
PARAMETER :: debug_this_module = .true.
44 CHARACTER(len=*),
PARAMETER,
PRIVATE :: moduleN =
'input_cp2k_free_energy'
63 NULLIFY (subsection, keyword, print_key)
64 cpassert(.NOT.
ASSOCIATED(section))
66 description=
"Controls the calculation of free energy and free energy derivatives"// &
67 " with different possible methods", &
68 n_keywords=0, n_subsections=1, repeats=.false.)
71 description=
"Defines the method to use to compute free energy.", &
72 usage=
"METHOD (METADYN|UI|AC)", &
73 enum_c_vals=
s2a(
"METADYN",
"UI",
"AC"), &
75 enum_desc=
s2a(
"Metadynamics", &
76 "Umbrella Integration", &
77 "Alchemical Change"), &
82 CALL create_metadyn_section(subsection)
86 CALL create_ui_section(subsection)
90 CALL create_ac_section(subsection)
95 description=
"Controls the printing of basic and summary information during the"// &
96 " Free Energy calculation", &
109 SUBROUTINE create_metadyn_section(section)
115 cpassert(.NOT.
ASSOCIATED(section))
117 description=
"This section sets parameters to set up a calculation of metadynamics.", &
118 n_keywords=1, n_subsections=1, repeats=.false., &
121 NULLIFY (subsection, keyword, print_key)
124 description=
"Specify whether to use plumed as an external metadynamics driver.", &
125 usage=
"USE_PLUMED .FALSE./.TRUE.", &
126 default_l_val=.false., lone_keyword_l_val=.true.)
130 CALL keyword_create(keyword, __location__, name=
"PLUMED_INPUT_FILE", &
131 description=
"Specify the file name of the external plumed input file", &
132 usage=
"PLUMED_INPUT_FILE ./FILENAME", &
133 default_c_val=
"./plumed.dat")
138 description=
"Specify the minimum MD step interval between spawning "// &
139 "two hills. If specified, it must be >= than NT_HILLS. In case MIN_DISP "// &
140 "is used, if MIN_DISP is satisfied before MIN_NT_HILLS MD steps have been "// &
141 "performed, the MD will continue without any spawning until MIN_NT_HILLS is "// &
142 "reached. The default value has the net effect of skipping this check.", &
143 usage=
"MIN_NT_HILLS {integer}", default_i_val=1)
148 description=
"Specify the maximum MD step interval between spawning "// &
149 "two hills. When negative, no new hills are spawned and only "// &
150 "the hills read from SPAWNED_HILLS_* are in effect. The latter "// &
151 "is useful when one wants to add a custom constant bias potential.", &
152 usage=
"NT_HILLS {integer}", default_i_val=30)
157 description=
"If a Lagrangian scheme is used the temperature for the collective "// &
158 "variables is specified. ", usage=
"TEMPERATURE <REAL>", &
159 default_r_val=0.0_dp, unit_str=
'K')
165 description=
"Minimum displacement between hills before placing a new hill.", &
166 usage=
"MIN_DISP <REAL>", &
167 default_r_val=-1.0_dp)
171 CALL keyword_create(keyword, __location__, name=
"OLD_HILL_NUMBER", &
172 description=
"Index of the last hill spawned for this walker.Needed to calculate MIN_DISP", &
173 usage=
"OLD_HILL_NUMBER <INT>", &
177 CALL keyword_create(keyword, __location__, name=
"OLD_HILL_STEP", &
178 description=
"Timestep of the last hill spawned for this walker.Needed to calculate MIN_DISP", &
179 usage=
"OLD_HILL_STEP <INT>", &
186 CALL keyword_create(keyword, __location__, name=
"HILL_TAIL_CUTOFF", &
187 description=
"By setting this variable larger than 0 the tail of the Gaussian hill "// &
188 "is damped to zero faster. Let $X_0$ be the location of the Gaussian and $\mathrm{SCALE}$ "// &
189 "be the width of the Gaussian (for more than one METAVAR, $X_0$ and $\mathrm{SCALE}$ are "// &
190 "METAVAR-dependent), and denote $S=\mathrm{HILL\_TAIL\_CUTOFF} \cdot \mathrm{SCALE}$. "// &
191 "The Gaussian function is multiplied by a cutoff function that becomes active at "// &
192 "$|x-X_0| \gt S$, namely $\dfrac{1-(|x-X_0|/S)^{P}}{1-(|x-X_0|/S)^{Q}}$", &
193 usage=
"HILL_TAIL_CUTOFF <REAL>", &
194 default_r_val=-1.0_dp)
198 description=
"Exponent $P$ at the numerator of the cutoff function "// &
199 "to damp the tail of the Gaussian.", &
200 usage=
"P_EXPONENT <INT>", &
205 description=
"Exponent $Q$ at the denominator of the cutoff function "// &
206 "to damp the tail of the Gaussian.", &
207 usage=
"Q_EXPONENT <INT>", &
213 description=
"Let the last hill grow slowly over NT_HILLS. ", &
214 usage=
"SLOW_GROWTH {logical}", &
215 default_l_val=.false., lone_keyword_l_val=.true.)
220 description=
"If a Lagrangian scheme is used the temperature tolerance for the collective "// &
221 "variables is specified.", usage=
"TEMP_TOL <REAL>", &
222 unit_str=
'K', default_r_val=0.0_dp)
227 description=
"If a Lagrangian scheme is used the eq. motion of the COLVARS are integrated "// &
228 "with a LANGEVIN scheme.", &
229 usage=
"LANGEVIN {logical}", &
231 default_l_val=.false., lone_keyword_l_val=.true.)
236 description=
"Specifies the height of the gaussian to spawn. Default 0.1 .", &
237 usage=
"WW <REAL>", unit_str=
'hartree', default_r_val=0.1_dp)
242 description=
"This keyword enables the spawning of the hills. Default .FALSE.", &
243 usage=
"DO_HILLS", default_l_val=.false., lone_keyword_l_val=.true.)
247 CALL keyword_create(keyword, __location__, name=
"WELL_TEMPERED", &
248 description=
"This keyword enables Well-tempered metadynamics. Default .FALSE.", &
250 default_l_val=.false., lone_keyword_l_val=.true.)
255 description=
"If Well-tempered metaD is used, the temperature parameter "// &
256 "must be specified.", usage=
"DELTA_T <REAL>", &
257 unit_str=
'K', default_r_val=0.0_dp)
262 description=
"If Well-tempered metaD is used, the gamma parameter "// &
263 "must be specified if not DELTA_T.", usage=
"WTGAMMA <REAL>", &
264 default_r_val=0.0_dp)
269 description=
"Specifies whether an extended-lagrangian should be used. Default .FALSE.", &
270 usage=
"LAGRANGE", default_l_val=.false., lone_keyword_l_val=.true.)
274 CALL keyword_create(keyword, __location__, name=
"step_start_val", &
275 description=
"The starting step value for metadynamics", &
276 usage=
"step_start_val <integer>", default_i_val=0)
280 CALL keyword_create(keyword, __location__, name=
"nhills_start_val", &
281 description=
"The starting value of previously spawned hills", &
282 usage=
"nhills_start_val <integer>", default_i_val=0)
286 CALL keyword_create(keyword, __location__, name=
"COLVAR_AVG_TEMPERATURE_RESTART", &
287 description=
"COLVAR average temperature. Only for restarting purposes.", &
288 usage=
"COLVAR_AVG_TEMPERATURE_RESTART 0.0", default_r_val=0.0_dp)
293 description=
"Number of sampling points for z", &
294 usage=
"TAMCSteps <integer>", default_i_val=1)
299 description=
"The length of an integration step for colvars (TAMC only)", &
300 usage=
"timestep <real>", default_r_val=
cp_unit_to_cp2k(
value=0.5_dp, unit_str=
"fs"), &
310 CALL create_multiple_walkers_section(subsection)
315 description=
"Controls the printing properties during an metadynamics run", &
316 n_keywords=0, n_subsections=1, repeats=.true.)
320 description=
"Controls the printing of basic and summary information during"// &
328 description=
"Controls the printing of the temperature of COLVARS in an "// &
329 "extended lagrangian scheme.", &
336 description=
"Controls the printing of COLVAR summary information during"// &
337 " metadynamics. When an extended Lagrangian use used, the files"// &
338 " contain (in order): colvar value of the extended Lagrangian,"// &
339 " instantaneous colvar value, force due to the harmonic term of the extended"// &
340 " Lagrangian and the force due to the previously spawned hills,"// &
341 " the force due to the walls, the velocities in the extended"// &
342 " Lagrangian, the potential of the harmonic term of the"// &
343 " Lagrangian, the potential energy of the hills, the potential"// &
344 " energy of the walls and the temperature of the extended"// &
345 " Lagrangian. When the extended Lagrangian is not used, all"// &
346 " related fields are omitted.", &
353 description=
"Controls the printing of HILLS summary information during"// &
354 " metadynamics. The file contains: instantaneous colvar value, width of"// &
355 " the spawned gaussian and height of the gaussian. According the value of"// &
356 " the EACH keyword this file may not be synchronized with the COLVAR file.", &
365 CALL create_metadyn_history(subsection, section)
366 END SUBROUTINE create_metadyn_section
373 SUBROUTINE create_multiple_walkers_section(section)
379 cpassert(.NOT.
ASSOCIATED(section))
380 CALL section_create(section, __location__, name=
"MULTIPLE_WALKERS", &
381 description=
"Enables and configures the metadynamics using multiple walkers.", &
382 n_keywords=0, n_subsections=0, repeats=.false.)
384 NULLIFY (subsection, keyword)
385 CALL keyword_create(keyword, __location__, name=
"_SECTION_PARAMETERS_", &
386 description=
"Controls the usage of the multiple walkers in a metadynamics run.", &
387 usage=
"&MULTIPLE_WALKERS T", default_l_val=.false., lone_keyword_l_val=.true.)
392 description=
"Sets the walker ID for the local metadynamics run.", &
393 usage=
"WALKER_ID <INTEGER>", type_of_var=
integer_t)
397 CALL keyword_create(keyword, __location__, name=
"NUMBER_OF_WALKERS", &
398 description=
"Sets the total number of walkers in the metadynamic run.", &
399 usage=
"NUMBER_OF_WALKERS <INTEGER>", type_of_var=
integer_t)
403 CALL keyword_create(keyword, __location__, name=
"WALKER_COMM_FREQUENCY", &
404 description=
"Sets the frequency (in unit of spawned hills) for the "// &
405 "communication between the several walkers, in order to update the "// &
406 "local list of hills with the ones coming from the other walkers", &
407 usage=
"WALKER_COMM_FREQUENCY <INTEGER>", default_i_val=1)
411 CALL keyword_create(keyword, __location__, name=
"WALKERS_STATUS", &
412 description=
"Stores the status of the several walkers in the local run.", &
413 usage=
"WALKERS_STATUS <INTEGER> .. <INTEGER>", type_of_var=
integer_t, n_var=-1)
417 CALL section_create(subsection, __location__, name=
"WALKERS_FILE_NAME", &
418 description=
"Specify the basename for the NUMBER_OF_WALKERS files used to "// &
419 "communicate between the walkers. Absolute path can be input as well "// &
420 "together with the filename. One file will be created for each spawned hill.", &
421 n_keywords=1, n_subsections=0, repeats=.false.)
422 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
423 description=
"Specified the communication filename for each walker.", repeats=.true., &
424 usage=
"{String}", type_of_var=
lchar_t, n_var=1)
429 END SUBROUTINE create_multiple_walkers_section
436 SUBROUTINE create_ac_section(section)
442 cpassert(.NOT.
ASSOCIATED(section))
443 CALL section_create(section, __location__, name=
"ALCHEMICAL_CHANGE", &
444 description=
"Controls the calculation of delta free energies with the "// &
445 "alchemical change method. This requires setting up a generic mixed "// &
446 "force env with the FORCE_EVAL/MIXED/MIXING_TYPE keyword set as GENMIX "// &
447 "and the coupling function defined in the FORCE_EVAL/MIXED/GENERIC section.", &
448 n_keywords=0, n_subsections=0, repeats=.false.)
451 description=
"Defines the symbol for the perturbing parameter of the "// &
452 "alchemical change transformation. This must be one of the symbols "// &
453 "for the corresponding FORCE_EVAL/MIXED/GENERIC/PARAMETERS keyword.", &
454 usage=
"PARAMETER k", type_of_var=
char_t, &
459 CALL keyword_create(keyword, __location__, name=
"WEIGHTING_FUNCTION", &
460 description=
"Specifies the weighting function (umbrella potential, "// &
461 "part of the mixing function) using the identical symbols for the "// &
462 "parameters and variables in FORCE_EVAL/MIXED/GENERIC.", &
463 usage=
"WEIGHTING_FUNCTION (E1+E2-LOG(E1/E2))", type_of_var=
lchar_t, &
464 n_var=1, default_lc_val=
"0")
469 description=
"Set the relative tolerance for the convergence of the free energy derivative", &
470 usage=
"EPS_CONV <REAL>", &
471 default_r_val=1.0e-2_dp)
476 description=
"Set the number of equilibration steps, skipped to compute averages", &
477 usage=
"NEQUIL_STEPS <INTEGER>", &
482 END SUBROUTINE create_ac_section
489 SUBROUTINE create_ui_section(section)
494 cpassert(.NOT.
ASSOCIATED(section))
495 CALL section_create(section, __location__, name=
"umbrella_integration", &
496 description=
"Controls the calculation of free energy derivatives"// &
497 " with the umbrella integration method.", &
498 n_keywords=0, n_subsections=0, repeats=.false.)
501 CALL create_uvar_conv_section(subsection)
505 CALL create_uvar_section(subsection)
509 END SUBROUTINE create_ui_section
517 SUBROUTINE create_metadyn_history(section, metadyn_section)
522 cpassert(.NOT.
ASSOCIATED(section))
523 CALL section_create(section, __location__, name=
"SPAWNED_HILLS_POS", &
524 description=
"The position of the spawned hills during metadynamics. "// &
525 "Used for RESTART.", &
526 n_keywords=1, n_subsections=0, repeats=.false.)
528 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
529 description=
"Specify the spawned hills", repeats=.true., &
530 usage=
"{Real} ...", type_of_var=
real_t, n_var=-1)
536 CALL section_create(section, __location__, name=
"SPAWNED_HILLS_SCALE", &
537 description=
"The scales of the spawned hills during metadynamics. "// &
538 "Used for RESTART. When a scale is zero in one or more "// &
539 "directions, the Gaussian hill is assumed to be infinitely wide "// &
540 "in those directions. The latter can be used to combine spawned "// &
541 "hills from multiple 1D metadynamics runs in one multidimensional "// &
542 "metadynamics run.", &
543 n_keywords=1, n_subsections=0, repeats=.false.)
545 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
546 description=
"Specify the spawned hills", repeats=.true., &
547 usage=
"{Real} ...", type_of_var=
real_t, n_var=-1)
553 CALL section_create(section, __location__, name=
"SPAWNED_HILLS_HEIGHT", &
554 description=
"The height of the spawned hills during metadynamics. "// &
555 "Used for RESTART.", &
556 n_keywords=1, n_subsections=0, repeats=.false.)
558 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
559 description=
"Specify the spawned hills", repeats=.true., &
560 usage=
"{Real}", type_of_var=
real_t, n_var=1)
566 CALL section_create(section, __location__, name=
"SPAWNED_HILLS_INVDT", &
567 description=
"The inverse of the DELTA_T parameter used for Well-Tempered metadynamics. "// &
568 "Used for RESTART.", &
569 n_keywords=1, n_subsections=0, repeats=.false.)
571 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
572 description=
"Specify the spawned hills", repeats=.true., &
573 usage=
"{Real}", type_of_var=
real_t, n_var=1)
581 CALL section_create(section, __location__, name=
"EXT_LAGRANGE_SS0", &
582 description=
"Colvar position within an extended Lagrangian formalism. "// &
583 "Used for RESTART.", &
584 n_keywords=1, n_subsections=0, repeats=.false.)
586 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
587 description=
"Specified the positions", repeats=.true., &
588 usage=
"{Real}", type_of_var=
real_t, n_var=1)
594 CALL section_create(section, __location__, name=
"EXT_LAGRANGE_VVP", &
595 description=
"Colvar velocities within an extended Lagrangian formalism. "// &
596 "Used for RESTART.", &
597 n_keywords=1, n_subsections=0, repeats=.false.)
599 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
600 description=
"Specified the velocities", repeats=.true., &
601 usage=
"{Real}", type_of_var=
real_t, n_var=1)
607 CALL section_create(section, __location__, name=
"EXT_LAGRANGE_SS", &
608 description=
"Colvar Theta within an extended Lagrangian formalism. "// &
609 "Used for RESTART.", &
610 n_keywords=1, n_subsections=0, repeats=.false.)
612 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
613 description=
"Specified the theta", repeats=.true., &
614 usage=
"{Real}", type_of_var=
real_t, n_var=1)
620 CALL section_create(section, __location__, name=
"EXT_LAGRANGE_FS", &
621 description=
"Colvar force within an extended Lagrangian formalism. "// &
622 "Used for RESTART.", &
623 n_keywords=1, n_subsections=0, repeats=.false.)
625 CALL keyword_create(keyword, __location__, name=
"_DEFAULT_KEYWORD_", &
626 description=
"Specified the theta", repeats=.true., &
627 usage=
"{Real}", type_of_var=
real_t, n_var=1)
633 END SUBROUTINE create_metadyn_history
646 cpassert(.NOT.
ASSOCIATED(section))
648 description=
"This section specify the nature of the collective variables.", &
649 n_keywords=1, n_subsections=1, repeats=.true.)
653 description=
"Specifies the lambda parameter for the coupling of the collective variable with the system coordinates in the"// &
654 " extended lagrangian scheme.", &
655 usage=
"LAMBDA <REAL>", unit_str=
'internal_cp2k', type_of_var=
real_t)
660 description=
"Specifies the mass parameter of the collective variable in the"// &
661 " extended lagrangian scheme.", usage=
"MASS <REAL>", unit_str=
'amu', type_of_var=
real_t)
666 description=
"Specifies the friction term in Langevin integration of the collective variable in the"// &
667 " extended lagrangian scheme.", &
669 usage=
"GAMMA {real}", type_of_var=
real_t, unit_str=
"fs^-1")
674 variants=[
"WIDTH"], &
675 description=
"Specifies the scale factor for the following collective variable. The history "// &
676 "dependent term has the expression: $\mathrm{WW} \sum_{j=1}^{n_{hills}} \prod_{k=1}^{n_{colvar}} "// &
677 "\exp{[-0.5(\frac{\mathrm{ss}-\mathrm{ss0}(k,j)}{\mathrm{SCALE}(k)})^2]}$, "// &
678 "where $n_{colvar}$ is the number of defined METAVAR and $n_{hills}$ is the number of spawned hills. ", &
679 usage=
"SCALE <REAL>", type_of_var=
real_t, unit_str=
'internal_cp2k')
684 description=
"Specifies the colvar on which to apply metadynamics.", &
685 usage=
"COLVAR {integer}", type_of_var=
integer_t)
690 NULLIFY (wall_section, subsection)
692 description=
"Controls the activation of walls on COLVAR during a metadynamic run.", &
693 n_keywords=0, n_subsections=1, repeats=.true.)
696 keyword, __location__, name=
"TYPE", &
697 description=
"Specify the type of wall", &
698 usage=
"TYPE (REFLECTIVE|QUADRATIC|QUARTIC|GAUSSIAN|NONE)", &
699 enum_c_vals=
s2a(
"REFLECTIVE",
"QUADRATIC",
"QUARTIC",
"GAUSSIAN",
"NONE"), &
700 enum_desc=
s2a(
"Reflective wall. Colvar velocity is inverted when the colvar is beyond the wall position.", &
701 "Applies a quadratic potential at the wall position.", &
702 "Applies a quartic potential at the wall position.", &
703 "Applies a gaussian potential at the wall position.", &
704 "No walls are applied."), &
711 description=
"Specify the value of the colvar for the wall position", &
712 usage=
"POSITION <REAL>", unit_str=
'internal_cp2k', &
718 CALL section_create(subsection, __location__, name=
"REFLECTIVE", &
719 description=
"Parameters controlling the reflective wall", &
720 n_keywords=0, n_subsections=1, repeats=.false.)
723 description=
"Specify the direction of the wall.", &
724 usage=
"DIRECTION (WALL_PLUS|WALL_MINUS)", &
725 enum_c_vals=
s2a(
"WALL_PLUS",
"WALL_MINUS"), &
726 enum_desc=
s2a(
"Wall extends from the position towards larger values of COLVAR", &
727 "Wall extends from the position towards smaller values of COLVAR"), &
736 description=
"Parameters controlling the quadratic wall "// &
737 "$K (\mathrm{CV}-\mathrm{POS})^2$", &
738 n_keywords=0, n_subsections=1, repeats=.false.)
741 description=
"Specify the direction of the wall.", &
742 usage=
"DIRECTION (WALL_PLUS|WALL_MINUS)", &
743 enum_c_vals=
s2a(
"WALL_PLUS",
"WALL_MINUS"), &
744 enum_desc=
s2a(
"Wall extends from the position towards larger values of COLVAR", &
745 "Wall extends from the position towards smaller values of COLVAR"), &
751 description=
"Specify the value of the quadratic potential constant $K$.", &
752 usage=
"K <REAL>", unit_str=
'hartree', type_of_var=
real_t)
761 description=
"Parameters controlling the quartic wall "// &
762 "$K (\mathrm{CV}-(\mathrm{POS}\pm\frac{0.05}{K^{1/4}}))^4$", &
763 n_keywords=0, n_subsections=1, repeats=.false.)
766 description=
"Specify the direction of the wall.", &
767 usage=
"DIRECTION (WALL_PLUS|WALL_MINUS)", &
768 enum_c_vals=
s2a(
"WALL_PLUS",
"WALL_MINUS"), &
769 enum_desc=
s2a(
"Wall extends from the position towards larger values of COLVAR", &
770 "Wall extends from the position towards smaller values of COLVAR"), &
776 description=
"Specify the value of the quartic potential constant $K$.", &
777 usage=
"K <REAL>", unit_str=
'hartree', &
787 description=
"Parameters controlling the gaussian wall "// &
788 "$\mathrm{WW} \exp{(-(\frac{\mathrm{CV}-\mathrm{POS}}{\sigma})^2)}$.", &
789 n_keywords=0, n_subsections=1, repeats=.false.)
792 description=
"Specify the height $\mathrm{WW}$ of the gaussian.", &
793 usage=
"WW <REAL>", unit_str=
'hartree', &
799 description=
"Specify the width $\sigma$ of the gaussian.", &
800 usage=
"SIGMA <REAL>", unit_str=
'internal_cp2k', &
818 SUBROUTINE create_uvar_section(section)
823 cpassert(.NOT.
ASSOCIATED(section))
825 description=
"This section specify the nature of the collective variables"// &
826 " used in computing the free energy.", &
827 n_keywords=1, n_subsections=1, repeats=.true.)
832 description=
"Specifies the colvar used to compute free energy", &
833 usage=
"COLVAR {integer}", type_of_var=
integer_t)
836 END SUBROUTINE create_uvar_section
844 SUBROUTINE create_uvar_conv_section(section)
849 cpassert(.NOT.
ASSOCIATED(section))
850 CALL section_create(section, __location__, name=
"CONVERGENCE_CONTROL", &
851 description=
"This section specify parameters controlling the convergence"// &
852 " of the free energy.", &
853 n_keywords=1, n_subsections=1, repeats=.true.)
856 CALL keyword_create(keyword, __location__, name=
"COARSE_GRAINED_WIDTH", &
857 variants=[
"CG_WIDTH"], &
858 description=
"Width of segments in MD steps to generate the set of"// &
859 " coarse grained data, providing a correlation independent data set.", &
860 usage=
"COARSE_GRAINED_WIDTH <INTEGER>", default_i_val=50)
864 CALL keyword_create(keyword, __location__, name=
"MAX_COARSE_GRAINED_WIDTH", &
865 variants=[
"MAX_CG_WIDTH"], &
866 description=
"Max Width of segments in MD steps to generate the set of"// &
867 " coarse grained data.", &
868 usage=
"MAX_COARSE_GRAINED_WIDTH <INTEGER>", default_i_val=200)
872 CALL keyword_create(keyword, __location__, name=
"COARSE_GRAINED_POINTS", &
873 variants=[
"CG_POINTS"], &
874 description=
"Set the minimum amount of coarse grained points to collect"// &
875 " before starting the statistical analysis", &
876 usage=
"COARSE_GRAINED_POINTS <INTEGER>", default_i_val=30)
881 description=
"Set the relative tolerance for the convergence of the collective"// &
882 " variable averages used to compute the free energy.", &
883 usage=
"EPS_CONV <REAL>", &
884 default_r_val=1.0e-2_dp)
888 CALL keyword_create(keyword, __location__, name=
"K_CONFIDENCE_LIMIT", &
889 description=
"Set the confidence limit for the Mann-Kendall trend test.", &
890 usage=
"K_CONFIDENCE_LIMIT <REAL>", &
891 default_r_val=0.90_dp)
895 CALL keyword_create(keyword, __location__, name=
"SW_CONFIDENCE_LIMIT", &
896 description=
"Set the confidence limit for the Shapiro-Wilks normality test.", &
897 usage=
"SW_CONFIDENCE_LIMIT <REAL>", &
898 default_r_val=0.90_dp)
902 CALL keyword_create(keyword, __location__, name=
"VN_CONFIDENCE_LIMIT", &
903 description=
"Set the confidence limit for the Von Neumann serial correlation test.", &
904 usage=
"VN_CONFIDENCE_LIMIT <REAL>", &
905 default_r_val=0.90_dp)
908 END SUBROUTINE create_uvar_conv_section
collects all references to literature in CP2K as new algorithms / method are included from literature...
integer, save, public barducbus2008
integer, save, public vandencic2006
routines to handle the output, The idea is to remove the decision of wheter to output and what to out...
subroutine, public cp_print_key_section_create(print_key_section, location, name, description, print_level, each_iter_names, each_iter_values, add_last, filename, common_iter_levels, citations, unit_str, do_backup)
creates a print_key section
integer, parameter, public low_print_level
integer, parameter, public high_print_level
integer, parameter, public add_last_numeric
real(kind=dp) function, public cp_unit_to_cp2k(value, unit_str, defaults, power)
converts to the internal cp2k units to the given unit
Defines the basic variable types.
integer, parameter, public dp
Utilities for string manipulations.