Skip to content

Commit 1d8874e

Browse files
committed
Doc: Update the doc
1 parent e8d1a09 commit 1d8874e

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1368,7 +1368,7 @@
13681368
### scf_ene_thr
13691369

13701370
- **Type**: Real
1371-
- **Description**: It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the electron densities before and after the `Hpsi` operation in one SCF step. It is not the same as the screen-output `EDIFF`, which is the energy difference before `Hpsi` and after charge mixing (i.e., across both `Hpsi` and charge-mixing operations).
1371+
- **Description**: It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the charge densities before and after the `Hpsi` operation in one SCF step. It is not the same as the screen-output `EDIFF`, which is the energy difference before `Hpsi` and after charge mixing (i.e., across both `Hpsi` and charge-mixing operations).
13721372
- **Default**: -1.0. If the user does not set this parameter, it will not take effect.
13731373
- **Unit**: eV
13741374

docs/parameters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ parameters:
831831
category: Electronic structure
832832
type: Real
833833
description: |
834-
It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the electron densities before and after the `Hpsi` operation in one SCF step. It is not the same as the screen-output `EDIFF`, which is the energy difference before `Hpsi` and after charge mixing (i.e., across both `Hpsi` and charge-mixing operations).
834+
It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the charge densities before and after the `Hpsi` operation in one SCF step. It is not the same as the screen-output `EDIFF`, which is the energy difference before `Hpsi` and after charge mixing (i.e., across both `Hpsi` and charge-mixing operations).
835835
default_value: "-1.0. If the user does not set this parameter, it will not take effect."
836836
unit: eV
837837
availability: ""

source/source_io/module_parameter/read_input_item_elec_stru.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ Note: If gamma_only is set to 1, the KPT file will be overwritten. So make sure
865865
item.annotation = "total energy error threshold";
866866
item.category = "Electronic structure";
867867
item.type = "Real";
868-
item.description = "It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the electron densities before and after the Hpsi operation in one SCF step. It is not the same as the screen-output EDIFF, which is the energy difference before Hpsi and after charge mixing (i.e., across both Hpsi and charge-mixing operations).";
868+
item.description = "It's the energy threshold for electronic iteration. The compared quantity is the total-energy difference evaluated from the charge densities before and after the Hpsi operation in one SCF step. It is not the same as the screen-output EDIFF, which is the energy difference before Hpsi and after charge mixing (i.e., across both Hpsi and charge-mixing operations).";
869869
item.default_value = "-1.0. If the user does not set this parameter, it will not take effect.";
870870
item.unit = "eV";
871871
item.availability = "";

0 commit comments

Comments
 (0)