(git:27c966b)
Loading...
Searching...
No Matches
input_cp2k_external.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 function that build the input sections for external [potential, density VXC]
10!> \par History
11!> 10.2005 moved out of input_cp2k [fawzi]
12!> 10.2020 moved out of input_cp2k_dft [JGH]
13!> 10.2026 applied create_function_section to create_ext_pot_section [Zilong He]
14!> \author fawzi
15! **************************************************************************************************
17 USE bibliography, ONLY: tozer1996,&
20 USE input_constants, ONLY: use_coulomb,&
21 use_diff,&
22 use_no
31 USE input_val_types, ONLY: char_t
32 USE kinds, ONLY: dp
33 USE string_utilities, ONLY: newline,&
34 s2a
35#include "./base/base_uses.f90"
36
37 IMPLICIT NONE
38 PRIVATE
39
40 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'input_cp2k_external'
41
43
44CONTAINS
45
46! **************************************************************************************************
47!> \brief Creates the section for applying an electrostatic external potential
48!> \param section ...
49!> \date 12.2009
50!> \par This is for FORCE_EVAL/DFT/EXTERNAL_POTENTIAL and applicable to Quickstep DFT only,
51!> corresponding to get_external_potential in qs_external_potential.F.
52!> Not to be confused with FORCE_EVAL/EXTERNAL_POTENTIAL, which is created separately
53!> in input_cp2k_force_eval.F and applicable to any force method.
54!> \author teo
55! **************************************************************************************************
56 SUBROUTINE create_ext_pot_section(section)
57 TYPE(section_type), POINTER :: section
58
59 TYPE(keyword_type), POINTER :: keyword
60 TYPE(section_type), POINTER :: subsection
61
62 cpassert(.NOT. ASSOCIATED(section))
63
64 CALL create_function_section(section, "EXTERNAL_POTENTIAL", "FUNCTION", &
65 description="Section controlling the presence of an electrostatic "// &
66 "external potential dependent on the atomic positions (X,Y,Z). "// &
67 "As the external potential is currently applied via a grid, "// &
68 "it only works with DFT based methods (GPW/GAPW) that already use "// &
69 "a grid-based approach to solve the Poisson equation. Not to be "// &
70 "confused with other similar sections:"//newline//newline// &
71 "* FORCE_EVAL/EXTERNAL_POTENTIAL, which is applicable to general "// &
72 "force methods and is not grid-based;"//newline// &
73 "* FORCE_EVAL/DFT/EFIELD, which is for finite, time-dependent "// &
74 "electric field in DFT;"//newline// &
75 "* FORCE_EVAL/DFT/PERIODIC_EFIELD, which is for finite periodic "// &
76 "electric field using the Berry phase approach in DFT.", &
77 do_deriv=.true., input_variables=["X", "Y", "Z"])
78 NULLIFY (keyword, subsection)
79
80 CALL keyword_create(keyword, __location__, name="STATIC", &
81 description="Specifies the external potential as STATIC or time dependent. At the moment "// &
82 "only static potentials are implemented.", &
83 usage="STATIC T", default_l_val=.true., lone_keyword_l_val=.true.)
84 CALL section_add_keyword(section, keyword)
85 CALL keyword_release(keyword)
86
87 !keyword for reading the external potential from cube file
88 CALL keyword_create(keyword, __location__, name="READ_FROM_CUBE", &
89 description="Switch for reading the external potential from file pot.cube. The values "// &
90 "of the potential must be on the grid points of the realspace grid. "// &
91 "Whitespace-separated cube values are accepted. If adjacent values are written "// &
92 "without whitespace, each value must occupy a 13-character E13.5 field.", &
93 usage="READ_FROM_CUBE T", default_l_val=.false., lone_keyword_l_val=.true.)
94 CALL section_add_keyword(section, keyword)
95 CALL keyword_release(keyword)
96
97 !keyword for scaling the external potential that is read from file by a constant factor
98 CALL keyword_create(keyword, __location__, name="SCALING_FACTOR", &
99 description="A factor for scaling the the external potential that is read from file. "// &
100 "The value of the potential at each grid point is multiplied by this factor.", &
101 usage="SCALING_FACTOR <REAL>", default_r_val=1.0_dp)
102 CALL section_add_keyword(section, keyword)
103 CALL keyword_release(keyword)
104
105 CALL create_maxwell_section(subsection)
106 CALL section_add_subsection(section, subsection)
107 CALL section_release(subsection)
108
109 END SUBROUTINE create_ext_pot_section
110
111! **************************************************************************************************
112!> \brief Creates the section for applying an electrostatic external potential
113!> \param section ...
114!> \date 12.2009
115!> \author teo
116! **************************************************************************************************
117 SUBROUTINE create_maxwell_section(section)
118 TYPE(section_type), POINTER :: section
119
120 TYPE(keyword_type), POINTER :: keyword
121
122 cpassert(.NOT. ASSOCIATED(section))
123 CALL section_create(section, __location__, name="MAXWELL", &
124 description="Section controlling the calculation of an electrostatic "// &
125 "external potential calculated from Maxwell equations. ", &
126 n_keywords=1, n_subsections=0, repeats=.false.)
127 NULLIFY (keyword)
128
129 CALL keyword_create(keyword, __location__, name="TEST_LOGICAL", &
130 description="Test for logical value", &
131 usage="TEST_LOGICAL T", default_l_val=.false., lone_keyword_l_val=.true.)
132 CALL section_add_keyword(section, keyword)
133 CALL keyword_release(keyword)
134
135 CALL keyword_create(keyword, __location__, name="TEST_REAL", &
136 description="TEST for Real", &
137 usage="TEST_REAL <REAL>", default_r_val=1.0_dp)
138 CALL section_add_keyword(section, keyword)
139 CALL keyword_release(keyword)
140
141 CALL keyword_create(keyword, __location__, name="TEST_INTEGER", &
142 description="TEST for Int", &
143 usage="TEST_INTEGER <INT>", default_i_val=0)
144 CALL section_add_keyword(section, keyword)
145 CALL keyword_release(keyword)
146
147 END SUBROUTINE create_maxwell_section
148
149! **************************************************************************************************
150!> \brief ZMP Creates the section for reading user supplied external density
151!> \param section ...
152!> \date 03.2011
153!> \author D. Varsano [daniele.varsano@nano.cnr.it]
154! **************************************************************************************************
155 SUBROUTINE create_ext_den_section(section)
156 TYPE(section_type), POINTER :: section
157
158 TYPE(keyword_type), POINTER :: keyword
159
160 cpassert(.NOT. ASSOCIATED(section))
161 CALL section_create(section, __location__, name="EXTERNAL_DENSITY", &
162 description="Section for the use of the ZMP technique on external densities.", &
163 n_keywords=4, n_subsections=0, repeats=.false., &
164 citations=[zhao1994, tozer1996])
165 NULLIFY (keyword)
166
167 CALL keyword_create(keyword, __location__, name="FILE_DENSITY", &
168 description="Specifies the filename containing the target density in *.cube format. "// &
169 "In the MGRID section it must be imposed NGRID 1, as it works with only "// &
170 "one grid. The number of points in each direction, and the spacing must "// &
171 "be previously defined choosing the plane waves cut-off in section MGRID "// &
172 "keyword CUTOFF, and the cube dimension in section SUBSYS / CELL / keyword ABC", &
173 usage="FILE_DENSITY <FILENAME>", &
174 type_of_var=char_t, default_c_val="RHO_O.dat", n_var=-1)
175 CALL section_add_keyword(section, keyword)
176 CALL keyword_release(keyword)
177
178 CALL keyword_create(keyword, __location__, name="LAMBDA", &
179 description="Lagrange multiplier defined in the constraint ZMP method. When starting, use "// &
180 "small values when starting from scratch (around 5,10). Then gradually increase "// &
181 "the values depending, restarting from the previous calculation with the smaller "// &
182 "value. To choose the progressive values of LAMBDA look at the convergence of the "// &
183 "eigenvalues.", &
184 usage="LAMBDA <REAL>", default_r_val=10.0_dp)
185 CALL section_add_keyword(section, keyword)
186 CALL keyword_release(keyword)
187
188 CALL keyword_create(keyword, __location__, name="ZMP_CONSTRAINT", &
189 description="Specify which kind of constraint to solve the ZMP equation. The COULOMB default "// &
190 "option is more stable.", &
191 usage="ZMP_CONSTRAINT <CHAR>", &
192 enum_c_vals=s2a("COULOMB", "DIFF", "NONE"), &
193 enum_i_vals=[use_coulomb, use_diff, use_no], &
194 enum_desc=s2a("Coulomb constraint, integral of [rho_0(r)-rho(r)]/|r-r'|", &
195 "Simple constraint, [rho_0(r)-rho(r)]", &
196 "No constrain imposed"), &
197 default_i_val=use_coulomb)
198 CALL section_add_keyword(section, keyword)
199 CALL keyword_release(keyword)
200
201 CALL keyword_create(keyword, __location__, name="FERMI_AMALDI", &
202 description="Add the Fermi-Amaldi contribution to the Hartree potential. "// &
203 "It leads to a more stable convergence.", &
204 usage="FERMI_AMALDI <LOGICAL>", &
205 repeats=.false., &
206 n_var=1, &
207 default_l_val=.true., lone_keyword_l_val=.true.)
208 CALL section_add_keyword(section, keyword)
209 CALL keyword_release(keyword)
210
211 END SUBROUTINE create_ext_den_section
212
213! **************************************************************************************************
214!> \brief ZMP Creates the section for creating the external v_xc
215!> \param section ...
216!> \date 03.2011
217!> \author D. Varsano [daniele.varsano@nano.cnr.it]
218! **************************************************************************************************
219 SUBROUTINE create_ext_vxc_section(section)
220 TYPE(section_type), POINTER :: section
221
222 TYPE(keyword_type), POINTER :: keyword
223
224 cpassert(.NOT. ASSOCIATED(section))
225 CALL section_create(section, __location__, name="EXTERNAL_VXC", &
226 description="SCF convergence with external v_xc calculated through previous ZMP "// &
227 "calculation", &
228 n_keywords=1, n_subsections=0, repeats=.false.)
229 NULLIFY (keyword)
230
231 CALL keyword_create(keyword, __location__, name="FILE_VXC", &
232 description="The *.cube filename containing the v_xc potential. This works only "// &
233 "with NGRID 1 imposed in the MGRID section. The number of points in each "// &
234 "direction, and the spacing must equal to those previously used in the ZMP "// &
235 "calculation and defined through the plane wave cut-off and the cube dimension "// &
236 "respectively set in section MGRID / keyword CUTOFF, and in section SUBSYS / "// &
237 "CELL / keyword ABC", &
238 usage="FILE_VXC <FILENAME>", &
239 type_of_var=char_t, default_c_val="VXC_O.dat", n_var=-1)
240 CALL section_add_keyword(section, keyword)
241 CALL keyword_release(keyword)
242 END SUBROUTINE create_ext_vxc_section
243
244END MODULE input_cp2k_external
collects all references to literature in CP2K as new algorithms / method are included from literature...
integer, save, public zhao1994
integer, save, public tozer1996
Creates and parses an input section to define a generic function.
subroutine, public create_function_section(gen_section, section_name, func_name, description, repeats, do_deriv, input_variables)
Create the input section for a generic function.
collects all constants needed in input so that they can be used without circular dependencies
integer, parameter, public use_coulomb
integer, parameter, public use_diff
integer, parameter, public use_no
function that build the input sections for external [potential, density VXC]
subroutine, public create_ext_pot_section(section)
Creates the section for applying an electrostatic external potential.
subroutine, public create_ext_vxc_section(section)
ZMP Creates the section for creating the external v_xc.
subroutine, public create_ext_den_section(section)
ZMP Creates the section for reading user supplied external density.
represents keywords in an input
subroutine, public keyword_release(keyword)
releases the given keyword (see doc/ReferenceCounting.html)
subroutine, public keyword_create(keyword, location, name, description, usage, type_of_var, n_var, repeats, variants, default_val, default_l_val, default_r_val, default_lc_val, default_c_val, default_i_val, default_l_vals, default_r_vals, default_c_vals, default_i_vals, lone_keyword_val, lone_keyword_l_val, lone_keyword_r_val, lone_keyword_c_val, lone_keyword_i_val, lone_keyword_l_vals, lone_keyword_r_vals, lone_keyword_c_vals, lone_keyword_i_vals, enum_c_vals, enum_i_vals, enum, enum_strict, enum_desc, unit_str, citations, deprecation_notice, removed)
creates a keyword object
objects that represent the structure of input sections and the data contained in an input section
subroutine, public section_create(section, location, name, description, n_keywords, n_subsections, repeats, citations, deprecation_notice)
creates a list of keywords
subroutine, public section_add_keyword(section, keyword)
adds a keyword to the given section
subroutine, public section_add_subsection(section, subsection)
adds a subsection to the given section
recursive subroutine, public section_release(section)
releases the given keyword list (see doc/ReferenceCounting.html)
a wrapper for basic fortran types.
integer, parameter, public char_t
Defines the basic variable types.
Definition kinds.F:23
integer, parameter, public dp
Definition kinds.F:34
Utilities for string manipulations.
character(len=1), parameter, public newline
represent a keyword in the input
represent a section of the input file