Skip to content

Commit 6233aae

Browse files
committed
correct extended -> external
1 parent 1aafcc4 commit 6233aae

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,7 +1065,7 @@ calculations.
10651065
### xc_exch_ext
10661066

10671067
- **Type**: Integer Real ...
1068-
- **Description**: Customized parameterization on the exchange part of XC functional. The first value should be the LibXC ID of the original functional, and latter values are extended parameters. Default values are those of Perdew-Burke-Ernzerhof (PBE) functional. For more information on LibXC ID of functionals, please refer to [LibXC](https://libxc.gitlab.io/functionals/). For parameters of functionals of interest, please refer to the source code of LibXC, such as PBE functional interface in LibXC: [gga_x_pbe.c](https://gitlab.com/libxc/libxc/-/blob/7.0.0/src/gga_x_pbe.c).
1068+
- **Description**: Customized parameterization on the exchange part of XC functional. The first value should be the LibXC ID of the original functional, and latter values are external parameters. Default values are those of Perdew-Burke-Ernzerhof (PBE) functional. For more information on LibXC ID of functionals, please refer to [LibXC](https://libxc.gitlab.io/functionals/). For parameters of functionals of interest, please refer to the source code of LibXC, such as PBE functional interface in LibXC: [gga_x_pbe.c](https://gitlab.com/libxc/libxc/-/blob/7.0.0/src/gga_x_pbe.c).
10691069
- **Default**: 101 0.8040 0.2195149727645171
10701070
- **Note**:
10711071
1. Solely setting this keyword will take no effect on XC functionals. One should also set `dft_functional` to corresponding functional to apply the customized parameterization. For example, if you want to use the PBE functional with customized parameters, you should set `dft_functional` to `GGA_X_PBE+GGA_C_PBE` and `xc_exch_ext` to `101 0.8040 0.2195149727645171`.
@@ -1075,7 +1075,7 @@ calculations.
10751075
### xc_corr_ext
10761076

10771077
- **Type**: Integer Real ...
1078-
- **Description**: Customized parameterization on the correlation part of XC functional. The first value should be the LibXC ID of the original functional, and latter values are extended parameters. Default values are those of Perdew-Burke-Ernzerhof (PBE) functional. For more information on LibXC ID of functionals, please refer to [LibXC](https://libxc.gitlab.io/functionals/). For parameters of functionals of interest, please refer to the source code of LibXC, such as PBE functional interface in LibXC: [gga_c_pbe.c](https://gitlab.com/libxc/libxc/-/blob/7.0.0/src/gga_c_pbe.c).
1078+
- **Description**: Customized parameterization on the correlation part of XC functional. The first value should be the LibXC ID of the original functional, and latter values are external parameters. Default values are those of Perdew-Burke-Ernzerhof (PBE) functional. For more information on LibXC ID of functionals, please refer to [LibXC](https://libxc.gitlab.io/functionals/). For parameters of functionals of interest, please refer to the source code of LibXC, such as PBE functional interface in LibXC: [gga_c_pbe.c](https://gitlab.com/libxc/libxc/-/blob/7.0.0/src/gga_c_pbe.c).
10791079
- **Default**: 130 0.06672455060314922 0.031090690869654895034 1.0
10801080
- **Note**:
10811081
1. Solely setting this keyword will take no effect on XC functionals. One should also set `dft_functional` to corresponding functional to apply the customized parameterization. For example, if you want to use the PBE functional with customized parameters, you should set `dft_functional` to `GGA_X_PBE+GGA_C_PBE` and `xc_corr_ext` to `130 0.06672455060314922 0.031090690869654895034 1.0`.

source/module_hamilt_general/module_xc/xc_functional_libxc.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ XC_Functional_Libxc::init_func(const std::vector<int> &func_id,
201201
funcs.push_back({}); // create placeholder
202202
xc_func_init(&funcs.back(), id, xc_polarized); // instantiate the XC term
203203

204-
// search for extended parameters
204+
// search for external parameters
205205
const std::vector<double> in_built_ext_params = in_built_xc_func_ext_params(id);
206206
const std::vector<double> external_ext_params = external_xc_func_ext_params(id);
207207
// for temporary use, I name their size as n1 and n2
@@ -221,12 +221,12 @@ XC_Functional_Libxc::init_func(const std::vector<int> &func_id,
221221
const double* xc_func_ext_params =
222222
(n2 > 0) ? external_ext_params.data() :
223223
(n1 > 0) ? in_built_ext_params.data() :
224-
nullptr; // nullptr if no extended parameters are found
224+
nullptr; // nullptr if no external parameters are found
225225

226-
// if there are no extended parameters, do nothing, otherwise we set
226+
// if there are no external parameters, do nothing, otherwise we set
227227
if(xc_func_ext_params != nullptr)
228228
{
229-
// set the extended parameters
229+
// set the external parameters
230230
xc_func_set_ext_params(&funcs.back(), const_cast<double*>(xc_func_ext_params));
231231
}
232232
}

source/module_hamilt_general/module_xc/xc_functional_libxc.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ namespace XC_Functional_Libxc
2828
extern std::pair<int,std::vector<int>> set_xc_type_libxc(const std::string& xc_func_in);
2929

3030
/**
31-
* @brief instantiate the XC functional by its ID, and set the extended parameters if provided.
31+
* @brief instantiate the XC functional by its ID, and set the external parameters if provided.
3232
*
3333
* @param func_id libxc ID of functional, see https://libxc.gitlab.io/functionals/ for details
3434
* @param xc_polarized 0: unpolarized, 1: spin-polarized
3535
* @return std::vector<xc_func_type>
3636
*
3737
* @note the functionality of this method is extended by supporting the user-defined
38-
* extended parameters of xc. However, there are several functionals' extended
38+
* external parameters of xc. However, there are several functionals' external
3939
* parameters are pre-defined in the code, which herein we call those are
4040
* "in-built" parameters. If the same functional ID is found in both in-built
4141
* and external parameters, the external parameters will overwrite the in-built ones.

source/module_parameter/input_parameter.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ struct Input_para
654654
bool exxace = true; // exxace, exact exchange for planewave basis, https://doi.org/10.1021/acs.jctc.6b00092
655655
bool exx_gamma_extrapolation = true; // gamma point extrapolation for exx, https://doi.org/10.1103/PhysRevB.79.205114
656656

657-
// ==== #Parameters (23.XC extended parameterization) ========
657+
// ==== #Parameters (23.XC external parameterization) ========
658658
/*
659659
* the following two sets of parameters are for the XC parameterization.
660660
* The first element should be the LibXC id, to assign the analytical

0 commit comments

Comments
 (0)