Skip to content

Commit c9e0d13

Browse files
committed
docs(gga_grad): sync parameters.yaml and document gga_grad in input-main.md
Add item.description for gga_grad in read_input_item_elec_stru.cpp and regenerate docs/parameters.yaml to fix the CI check that compares the yaml against the output of --generate-parameters-yaml. Also add the gga_grad entry to docs/advanced/input_files/input-main.md.
1 parent 2c234bf commit c9e0d13

3 files changed

Lines changed: 28 additions & 0 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1268,6 +1268,17 @@
12681268
- 4: For the case of noncollinear polarized, nspin will be automatically set to 4 without being specified by the user.
12691269
- **Default**: 1
12701270

1271+
### gga_grad
1272+
1273+
- **Type**: Integer
1274+
- **Description**: Method used to evaluate the density gradient entering GGA exchange-correlation terms in noncollinear-spin (nspin=4) calculations.
1275+
- 1: collinear approximation, only the gradient of the magnetization magnitude |m| is used.
1276+
- 2: projected method, the gradient of the magnetization direction is projected out via div(h), with h = m/|m|.
1277+
- 3: Scalmani-Frisch transformation (G. Scalmani and M. J. Frisch, J. Chem. Theory Comput. 8, 2193 (2012)), which retains all cross terms of grad(m/|m|); the most accurate and the default.
1278+
1279+
This parameter only takes effect for nspin=4 with GGA functionals (and magnetic calculation).
1280+
- **Default**: 3
1281+
12711282
### smearing_method
12721283

12731284
- **Type**: String

docs/parameters.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,18 @@ parameters:
665665
default_value: "1"
666666
unit: ""
667667
availability: ""
668+
- name: gga_grad
669+
category: Electronic structure
670+
type: Integer
671+
description: |
672+
Method used to evaluate the density gradient entering GGA exchange-correlation terms in noncollinear-spin (nspin=4) calculations.
673+
* 1: collinear approximation, only the gradient of the magnetization magnitude |m| is used.
674+
* 2: projected method, the gradient of the magnetization direction is projected out via div(h), with h = m/|m|.
675+
* 3: Scalmani-Frisch transformation (G. Scalmani and M. J. Frisch, J. Chem. Theory Comput. 8, 2193 (2012)), which retains all cross terms of grad(m/|m|); the most accurate and the default.
676+
This parameter only takes effect for nspin=4 with GGA functionals (and magnetic calculation).
677+
default_value: "3"
678+
unit: ""
679+
availability: ""
668680
- name: smearing_method
669681
category: Electronic structure
670682
type: String

source/source_io/module_parameter/read_input_item_elec_stru.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,11 @@ The other way is only available when compiling with LIBXC, and it allows for sup
506506
item.annotation = "GGA gradient method for nspin=4: 1 collinear approx, 2 projected div(h), 3 Scalmani-Frisch";
507507
item.category = "Electronic structure";
508508
item.type = "Integer";
509+
item.description = R"(Method used to evaluate the density gradient entering GGA exchange-correlation terms in noncollinear-spin (nspin=4) calculations.
510+
* 1: collinear approximation, only the gradient of the magnetization magnitude |m| is used.
511+
* 2: projected method, the gradient of the magnetization direction is projected out via div(h), with h = m/|m|.
512+
* 3: Scalmani-Frisch transformation (G. Scalmani and M. J. Frisch, J. Chem. Theory Comput. 8, 2193 (2012)), which retains all cross terms of grad(m/|m|); the most accurate and the default.
513+
This parameter only takes effect for nspin=4 with GGA functionals (and magnetic calculation).)";
509514
item.default_value = "3";
510515
read_sync_int(input.gga_grad);
511516
item.check_value = [](const Input_Item& item, const Parameter& para) {

0 commit comments

Comments
 (0)