Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/advanced/input_files/input-main.md
Original file line number Diff line number Diff line change
Expand Up @@ -1361,14 +1361,14 @@
### scf_thr

- **Type**: Real
- **Description**: It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. Usually for local orbitals, usually 1e-6 may be accurate enough.
- **Description**: It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. This criterion is always enabled. If `scf_ene_thr` is set, SCF is considered converged only when both the charge-density criterion (`scf_thr`) and the total-energy criterion (`scf_ene_thr`) are satisfied. For local-orbital calculations, 1e-6 is usually accurate enough.
Comment thread
sunliang98 marked this conversation as resolved.
Outdated
- **Default**: 1.0e-9 (plane-wave basis), or 1.0e-7 (localized atomic orbital basis).
- **Unit**: Ry if scf_thr_type=1, dimensionless if scf_thr_type=2

### scf_ene_thr

- **Type**: Real
- **Description**: It's the energy threshold for electronic iteration. It represents the total energy error between two sequential densities from electronic iterations.
- **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).
Comment thread
sunliang98 marked this conversation as resolved.
- **Default**: -1.0. If the user does not set this parameter, it will not take effect.
- **Unit**: eV

Expand Down
4 changes: 2 additions & 2 deletions docs/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -823,15 +823,15 @@ parameters:
category: Electronic structure
type: Real
description: |
It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. Usually for local orbitals, usually 1e-6 may be accurate enough.
It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. This criterion is always enabled. If `scf_ene_thr` is set, SCF is considered converged only when both the charge-density criterion (`scf_thr`) and the total-energy criterion (`scf_ene_thr`) are satisfied. For local-orbital calculations, 1e-6 is usually accurate enough.
Comment thread
sunliang98 marked this conversation as resolved.
Outdated
default_value: "1.0e-9 (plane-wave basis), or 1.0e-7 (localized atomic orbital basis)."
unit: "Ry if scf_thr_type=1, dimensionless if scf_thr_type=2"
availability: ""
- name: scf_ene_thr
category: Electronic structure
type: Real
description: |
It's the energy threshold for electronic iteration. It represents the total energy error between two sequential densities from electronic iterations.
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).
default_value: "-1.0. If the user does not set this parameter, it will not take effect."
unit: eV
availability: ""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,7 @@ Note: If gamma_only is set to 1, the KPT file will be overwritten. So make sure
item.annotation = "charge density error";
item.category = "Electronic structure";
item.type = "Real";
item.description = "It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. Usually for local orbitals, usually 1e-6 may be accurate enough.";
item.description = "It's the density threshold for electronic iteration. It represents the charge density error between two sequential densities from electronic iterations. This criterion is always enabled. If scf_ene_thr is set, SCF is considered converged only when both the charge-density criterion (scf_thr) and the total-energy criterion (scf_ene_thr) are satisfied. For local-orbital calculations, 1e-6 is usually accurate enough.";
Comment thread
sunliang98 marked this conversation as resolved.
Outdated
item.default_value = "1.0e-9 (plane-wave basis), or 1.0e-7 (localized atomic orbital basis).";
item.unit = "Ry if scf_thr_type=1, dimensionless if scf_thr_type=2";
item.availability = "";
Expand Down Expand Up @@ -865,7 +865,7 @@ Note: If gamma_only is set to 1, the KPT file will be overwritten. So make sure
item.annotation = "total energy error threshold";
item.category = "Electronic structure";
item.type = "Real";
item.description = "It's the energy threshold for electronic iteration. It represents the total energy error between two sequential densities from electronic iterations.";
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).";
item.default_value = "-1.0. If the user does not set this parameter, it will not take effect.";
item.unit = "eV";
item.availability = "";
Expand Down
Loading