You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
Zanthoxylum
committed
Docs: resync parameters.yaml and input-main.md with the C++ Input_Item generator
The DFPT parameter block was hand-placed at a position that differs from
the item_dfpt() registration order, so the byte-exact consistency checks
in test.yml (--generate-parameters-yaml / generate_input_main.py) fail.
Regenerate both files with the documented commands to restore sync; the
only change is the position of the DFPT category block.
Copy file name to clipboardExpand all lines: docs/advanced/input_files/input-main.md
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5185,48 +5185,42 @@
5185
5185
### dfpt_qmesh
5186
5186
5187
5187
-**Type**: Vector of Int (1 or 3 values)
5188
-
-**Availability**: *esolver_type = dfpt*
5189
5188
-**Description**: Set the Monkhorst-Pack q mesh (gamma-centered) for DFPT phonon calculations. The q mesh must be commensurate with the ground-state k mesh: k + q must be a point of the k list (modulo a reciprocal lattice vector). For example, a 4x4x4 KPT mesh is commensurate with dfpt_qmesh values of 1, 2, or 4 along each direction. This parameter is ignored when dfpt_qfile is set.
5190
5189
-**Default**: 1 1 1
5191
5190
5192
5191
### dfpt_qfile
5193
5192
5194
5193
-**Type**: String
5195
-
-**Availability**: *esolver_type = dfpt*
5196
5194
-**Description**: Set the file containing the q points for DFPT, in the same format as the KPT file (Q_POINTS card: Gamma/Monkhorst-Pack mesh, or an explicit Direct/Cartesian list; symmetry reduction is not applied to file q lists). When set, it overrides dfpt_qmesh. Each q point must still be commensurate with the ground-state k mesh.
5195
+
-**Default**: ""
5197
5196
5198
5197
### dfpt_compute_q0
5199
5198
5200
5199
-**Type**: Boolean
5201
-
-**Availability**: *esolver_type = dfpt*
5202
5200
-**Description**: Whether to compute the macroscopic dielectric tensor (epsilon_inf) and the Born effective charges at q = 0 within the same DFPT run. Requires a q point at Gamma (the default dfpt_qmesh 1 1 1).
5203
5201
-**Default**: false
5204
5202
5205
5203
### dfpt_loto
5206
5204
5207
5205
-**Type**: Boolean
5208
-
-**Availability**: *esolver_type = dfpt*
5209
5206
-**Description**: Whether to apply the Lyddane-Sachs-Teller non-analytic correction to the Gamma-point dynamical matrix, which splits the longitudinal and transverse optical modes. Requires dfpt_compute_q0 to be true, since the correction is built from epsilon_inf and the Born effective charges.
5210
5207
-**Default**: false
5211
5208
5212
5209
### dfpt_conv_thr
5213
5210
5214
5211
-**Type**: Real
5215
-
-**Availability**: *esolver_type = dfpt*
5216
5212
-**Description**: Set the convergence threshold of the self-consistent DFPT cycle: the iteration stops when the relative residual of the first-order density ||drho_out - drho_in|| / ||drho_out|| drops below this value for every displacement.
5217
5213
-**Default**: 1.0e-8
5218
5214
5219
5215
### dfpt_max_iter
5220
5216
5221
5217
-**Type**: Integer
5222
-
-**Availability**: *esolver_type = dfpt*
5223
5218
-**Description**: Set the maximum number of self-consistent DFPT iterations for each atomic displacement.
5224
5219
-**Default**: 100
5225
5220
5226
5221
### dfpt_mix_beta
5227
5222
5228
5223
-**Type**: Real
5229
-
-**Availability**: *esolver_type = dfpt*
5230
5224
-**Description**: Set the plain-mixing coefficient of the first-order density in the self-consistent DFPT cycle. The response Jacobian has strongly negative eigenvalues on the smallest-G shells (Coulomb stiffness), so beta must stay below 2 / (1 + |lambda_min|); the default 0.4 keeps margin up to |lambda_min| ~ 3. A larger value accelerates convergence for weakly screened systems but may diverge.
Copy file name to clipboardExpand all lines: docs/parameters.yaml
+56-56Lines changed: 56 additions & 56 deletions
Original file line number
Diff line number
Diff line change
@@ -2959,62 +2959,6 @@ parameters:
2959
2959
default_value: "0"
2960
2960
unit: ""
2961
2961
availability: ""
2962
-
- name: dfpt_qmesh
2963
-
category: Density functional perturbation theory
2964
-
type: Vector of Int (1 or 3 values)
2965
-
description: |
2966
-
Set the Monkhorst-Pack q mesh (gamma-centered) for DFPT phonon calculations. The q mesh must be commensurate with the ground-state k mesh: k + q must be a point of the k list (modulo a reciprocal lattice vector). For example, a 4x4x4 KPT mesh is commensurate with dfpt_qmesh values of 1, 2, or 4 along each direction. This parameter is ignored when dfpt_qfile is set.
2967
-
default_value: "1 1 1"
2968
-
unit: ""
2969
-
availability: esolver_type = dfpt
2970
-
- name: dfpt_qfile
2971
-
category: Density functional perturbation theory
2972
-
type: String
2973
-
description: |
2974
-
Set the file containing the q points for DFPT, in the same format as the KPT file (Q_POINTS card: Gamma/Monkhorst-Pack mesh, or an explicit Direct/Cartesian list; symmetry reduction is not applied to file q lists). When set, it overrides dfpt_qmesh. Each q point must still be commensurate with the ground-state k mesh.
2975
-
default_value: "\"\""
2976
-
unit: ""
2977
-
availability: esolver_type = dfpt
2978
-
- name: dfpt_compute_q0
2979
-
category: Density functional perturbation theory
2980
-
type: Boolean
2981
-
description: |
2982
-
Whether to compute the macroscopic dielectric tensor (epsilon_inf) and the Born effective charges at q = 0 within the same DFPT run. Requires a q point at Gamma (the default dfpt_qmesh 1 1 1).
2983
-
default_value: "false"
2984
-
unit: ""
2985
-
availability: esolver_type = dfpt
2986
-
- name: dfpt_loto
2987
-
category: Density functional perturbation theory
2988
-
type: Boolean
2989
-
description: |
2990
-
Whether to apply the Lyddane-Sachs-Teller non-analytic correction to the Gamma-point dynamical matrix, which splits the longitudinal and transverse optical modes. Requires dfpt_compute_q0 to be true, since the correction is built from epsilon_inf and the Born effective charges.
2991
-
default_value: "false"
2992
-
unit: ""
2993
-
availability: esolver_type = dfpt
2994
-
- name: dfpt_conv_thr
2995
-
category: Density functional perturbation theory
2996
-
type: Real
2997
-
description: |
2998
-
Set the convergence threshold of the self-consistent DFPT cycle: the iteration stops when the relative residual of the first-order density ||drho_out - drho_in|| / ||drho_out|| drops below this value for every displacement.
2999
-
default_value: "1.0e-8"
3000
-
unit: ""
3001
-
availability: esolver_type = dfpt
3002
-
- name: dfpt_max_iter
3003
-
category: Density functional perturbation theory
3004
-
type: Integer
3005
-
description: |
3006
-
Set the maximum number of self-consistent DFPT iterations for each atomic displacement.
3007
-
default_value: "100"
3008
-
unit: ""
3009
-
availability: esolver_type = dfpt
3010
-
- name: dfpt_mix_beta
3011
-
category: Density functional perturbation theory
3012
-
type: Real
3013
-
description: |
3014
-
Set the plain-mixing coefficient of the first-order density in the self-consistent DFPT cycle. The response Jacobian has strongly negative eigenvalues on the smallest-G shells (Coulomb stiffness), so beta must stay below 2 / (1 + |lambda_min|); the default 0.4 keeps margin up to |lambda_min| ~ 3. A larger value accelerates convergence for weakly screened systems but may diverge.
3015
-
default_value: "0.4"
3016
-
unit: ""
3017
-
availability: esolver_type = dfpt
3018
2962
- name: plot_istate
3019
2963
category: Linear Response TDDFT
3020
2964
type: Integer
@@ -3079,6 +3023,62 @@ parameters:
3079
3023
default_value: "-1 2 -1 2"
3080
3024
unit: primitive cells
3081
3025
availability: "lr_solver==plot and exciton_plot_format in [slice, both]"
3026
+
- name: dfpt_qmesh
3027
+
category: Density functional perturbation theory
3028
+
type: Vector of Int (1 or 3 values)
3029
+
description: |
3030
+
Set the Monkhorst-Pack q mesh (gamma-centered) for DFPT phonon calculations. The q mesh must be commensurate with the ground-state k mesh: k + q must be a point of the k list (modulo a reciprocal lattice vector). For example, a 4x4x4 KPT mesh is commensurate with dfpt_qmesh values of 1, 2, or 4 along each direction. This parameter is ignored when dfpt_qfile is set.
3031
+
default_value: 1 1 1
3032
+
unit: ""
3033
+
availability: ""
3034
+
- name: dfpt_qfile
3035
+
category: Density functional perturbation theory
3036
+
type: String
3037
+
description: |
3038
+
Set the file containing the q points for DFPT, in the same format as the KPT file (Q_POINTS card: Gamma/Monkhorst-Pack mesh, or an explicit Direct/Cartesian list; symmetry reduction is not applied to file q lists). When set, it overrides dfpt_qmesh. Each q point must still be commensurate with the ground-state k mesh.
3039
+
default_value: "\"\""
3040
+
unit: ""
3041
+
availability: ""
3042
+
- name: dfpt_compute_q0
3043
+
category: Density functional perturbation theory
3044
+
type: Boolean
3045
+
description: |
3046
+
Whether to compute the macroscopic dielectric tensor (epsilon_inf) and the Born effective charges at q = 0 within the same DFPT run. Requires a q point at Gamma (the default dfpt_qmesh 1 1 1).
3047
+
default_value: "false"
3048
+
unit: ""
3049
+
availability: ""
3050
+
- name: dfpt_loto
3051
+
category: Density functional perturbation theory
3052
+
type: Boolean
3053
+
description: |
3054
+
Whether to apply the Lyddane-Sachs-Teller non-analytic correction to the Gamma-point dynamical matrix, which splits the longitudinal and transverse optical modes. Requires dfpt_compute_q0 to be true, since the correction is built from epsilon_inf and the Born effective charges.
3055
+
default_value: "false"
3056
+
unit: ""
3057
+
availability: ""
3058
+
- name: dfpt_conv_thr
3059
+
category: Density functional perturbation theory
3060
+
type: Real
3061
+
description: |
3062
+
Set the convergence threshold of the self-consistent DFPT cycle: the iteration stops when the relative residual of the first-order density ||drho_out - drho_in|| / ||drho_out|| drops below this value for every displacement.
3063
+
default_value: "1.0e-8"
3064
+
unit: ""
3065
+
availability: ""
3066
+
- name: dfpt_max_iter
3067
+
category: Density functional perturbation theory
3068
+
type: Integer
3069
+
description: |
3070
+
Set the maximum number of self-consistent DFPT iterations for each atomic displacement.
3071
+
default_value: "100"
3072
+
unit: ""
3073
+
availability: ""
3074
+
- name: dfpt_mix_beta
3075
+
category: Density functional perturbation theory
3076
+
type: Real
3077
+
description: |
3078
+
Set the plain-mixing coefficient of the first-order density in the self-consistent DFPT cycle. The response Jacobian has strongly negative eigenvalues on the smallest-G shells (Coulomb stiffness), so beta must stay below 2 / (1 + |lambda_min|); the default 0.4 keeps margin up to |lambda_min| ~ 3. A larger value accelerates convergence for weakly screened systems but may diverge.
0 commit comments