Skip to content

Commit 50a82cb

Browse files
author
dyzheng
committed
Fix: input parameter yaml has been updated
1 parent e37932c commit 50a82cb

2 files changed

Lines changed: 31 additions & 32 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -976,8 +976,9 @@
976976
### pw_diag_nmax
977977

978978
- **Type**: Integer
979+
- **Availability**: *basis_type==pw, ks_solver==cg/dav/dav_subspace/bpcg*
979980
- **Description**: Only useful when you use ks_solver = cg/dav/dav_subspace/bpcg. It indicates the maximal iteration number for cg/david/dav_subspace/bpcg method.
980-
- **Default**: 40
981+
- **Default**: 50
981982

982983
### pw_diag_ndim
983984

@@ -1918,13 +1919,11 @@
19181919

19191920
- **Type**: Boolean \[Integer\](optional)
19201921
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
1921-
- **Description**: Output Hamiltonian H(R) and overlap S(R) matrices in CSR format. Optional second parameter specifies output precision (default 8). For more information, please refer to hs_matrix.md.
1922+
- **Description**: Whether to print files containing the Hamiltonian matrix and overlap matrix into files in the directory OUT.${suffix}. For more information, please refer to hs_matrix.md.
19221923

19231924
> Note: In the 3.10-LTS version, the file names are data-HR-sparse_SPIN0.csr and data-SR-sparse_SPIN0.csr, etc.
19241925
- **Default**: False [8]
19251926
- **Unit**: Ry
1926-
- **Output files**: `hrs1_nao.csr`, `hrs2_nao.csr` (if nspin=2), `srs1_nao.csr`
1927-
- **Format**: Standard CSR format with UnitCell header, compatible with `out_dmr` format
19281927

19291928
### out_mat_tk
19301929

@@ -1938,42 +1937,42 @@
19381937

19391938
### out_mat_r
19401939

1941-
- **Type**: Boolean
1940+
- **Type**: Boolean \[Integer\](optional)
19421941
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
1943-
- **Description**: Whether to print the matrix representation of the position matrix into a file named rr.csr in the directory OUT.${suffix}. If calculation is set to get_s, the position matrix can be obtained without scf iterations. For more information, please refer to position_matrix.md.
1942+
- **Description**: Whether to print the matrix representation of the position matrix into files named rxrs1_nao.csr, ryrs1_nao.csr, rzrs1_nao.csr in the directory OUT.${suffix}. If calculation is set to get_s, the position matrix can be obtained without scf iterations. For more information, please refer to position_matrix.md.
19441943

19451944
> Note: In the 3.10-LTS version, the file name is data-rR-sparse.csr.
1946-
- **Default**: False
1945+
- **Default**: False 8
19471946
- **Unit**: Bohr
19481947

19491948
### out_mat_t
19501949

1951-
- **Type**: Boolean
1950+
- **Type**: Boolean \[Integer\](optional)
19521951
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
19531952
- **Description**: Generate files containing the kinetic energy matrix. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be trs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
19541953

19551954
> Note: In the 3.10-LTS version, the file name is data-TR-sparse_SPIN0.csr.
1956-
- **Default**: False
1955+
- **Default**: False 8
19571956
- **Unit**: Ry
19581957

19591958
### out_mat_dh
19601959

1961-
- **Type**: Boolean
1960+
- **Type**: Integer
19621961
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
19631962
- **Description**: Whether to print files containing the derivatives of the Hamiltonian matrix. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be dhrxs1_nao.csr, dhrys1_nao.csr, dhrzs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
19641963

19651964
> Note: In the 3.10-LTS version, the file name is data-dHRx-sparse_SPIN0.csr and so on.
1966-
- **Default**: False
1965+
- **Default**: 0 8
19671966
- **Unit**: Ry/Bohr
19681967

19691968
### out_mat_ds
19701969

1971-
- **Type**: Boolean
1970+
- **Type**: Boolean \[Integer\](optional)
19721971
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
1973-
- **Description**: Whether to print files containing the derivatives of the overlap matrix. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsrxs1.csr and so on. Also controled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
1972+
- **Description**: Whether to print files containing the derivatives of the overlap matrix. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsxrs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
19741973

19751974
> Note: In the 3.10-LTS version, the file name is data-dSRx-sparse_SPIN0.csr and so on.
1976-
- **Default**: False
1975+
- **Default**: False 8
19771976
- **Unit**: Ry/Bohr
19781977

19791978
### out_mat_xc
@@ -1988,12 +1987,12 @@
19881987

19891988
### out_mat_xc2
19901989

1991-
- **Type**: Boolean
1990+
- **Type**: Boolean \[Integer\](optional)
19921991
- **Availability**: *Numerical atomic orbital (NAO) basis*
1993-
- **Description**: Whether to print the exchange-correlation matrices in numerical orbital representation: in CSR format in the directory OUT.s.
1992+
- **Description**: Whether to print the exchange-correlation matrices in numerical orbital representation: in CSR format in the directory OUT.${suffix}. The name of the files will be vxcrs1_nao.csr and so on.
19941993

19951994
> Note: In the 3.10-LTS version, the file name is Vxc_R_spin$s and so on.
1996-
- **Default**: False
1995+
- **Default**: False 8
19971996
- **Unit**: Ry
19981997

19991998
### out_mat_l

docs/parameters.yaml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -942,7 +942,7 @@ parameters:
942942
Only useful when you use ks_solver = cg/dav/dav_subspace/bpcg. It indicates the maximal iteration number for cg/david/dav_subspace/bpcg method.
943943
default_value: "50"
944944
unit: ""
945-
availability: "basis_type==pw, ks_solver== cg/dav/dav_subspace/bpcg"
945+
availability: "basis_type==pw, ks_solver==cg/dav/dav_subspace/bpcg"
946946
- name: pw_diag_ndim
947947
category: Plane wave related variables
948948
type: Integer
@@ -2984,7 +2984,7 @@ parameters:
29842984
category: Output information
29852985
type: "Boolean \\[Integer\\](optional)"
29862986
description: |
2987-
Output H(R) and S(R) matrices in CSR format with optional precision. Optional second parameter specifies output precision (default 8). For more information, please refer to hs_matrix.md.
2987+
Whether to print files containing the Hamiltonian matrix and overlap matrix into files in the directory OUT.${suffix}. For more information, please refer to hs_matrix.md.
29882988
29892989
[NOTE] In the 3.10-LTS version, the file names are data-HR-sparse_SPIN0.csr and data-SR-sparse_SPIN0.csr, etc.
29902990
default_value: "False [8]"
@@ -3002,42 +3002,42 @@ parameters:
30023002
availability: Numerical atomic orbital basis
30033003
- name: out_mat_r
30043004
category: Output information
3005-
type: Boolean
3005+
type: "Boolean \\[Integer\\](optional)"
30063006
description: |
3007-
Whether to print the matrix representation of the position matrix into a file named rr.csr in the directory OUT.${suffix}. If calculation is set to get_s, the position matrix can be obtained without scf iterations. For more information, please refer to position_matrix.md.
3007+
Whether to print the matrix representation of the position matrix into files named rxrs1_nao.csr, ryrs1_nao.csr, rzrs1_nao.csr in the directory OUT.${suffix}. If calculation is set to get_s, the position matrix can be obtained without scf iterations. For more information, please refer to position_matrix.md.
30083008
30093009
[NOTE] In the 3.10-LTS version, the file name is data-rR-sparse.csr.
3010-
default_value: "False"
3010+
default_value: False 8
30113011
unit: Bohr
30123012
availability: Numerical atomic orbital basis (not gamma-only algorithm)
30133013
- name: out_mat_t
30143014
category: Output information
3015-
type: Boolean
3015+
type: "Boolean \\[Integer\\](optional)"
30163016
description: |
30173017
Generate files containing the kinetic energy matrix. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be trs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
30183018
30193019
[NOTE] In the 3.10-LTS version, the file name is data-TR-sparse_SPIN0.csr.
3020-
default_value: "False"
3020+
default_value: False 8
30213021
unit: Ry
30223022
availability: Numerical atomic orbital basis (not gamma-only algorithm)
30233023
- name: out_mat_dh
30243024
category: Output information
3025-
type: Boolean
3025+
type: Integer
30263026
description: |
30273027
Whether to print files containing the derivatives of the Hamiltonian matrix. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be dhrxs1_nao.csr, dhrys1_nao.csr, dhrzs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
30283028
30293029
[NOTE] In the 3.10-LTS version, the file name is data-dHRx-sparse_SPIN0.csr and so on.
3030-
default_value: "False"
3030+
default_value: 0 8
30313031
unit: Ry/Bohr
30323032
availability: Numerical atomic orbital basis (not gamma-only algorithm)
30333033
- name: out_mat_ds
30343034
category: Output information
3035-
type: Boolean
3035+
type: "Boolean \\[Integer\\](optional)"
30363036
description: |
3037-
Whether to print files containing the derivatives of the overlap matrix. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsrxs1.csr and so on. Also controled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
3037+
Whether to print files containing the derivatives of the overlap matrix. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsxrs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
30383038
30393039
[NOTE] In the 3.10-LTS version, the file name is data-dSRx-sparse_SPIN0.csr and so on.
3040-
default_value: "False"
3040+
default_value: False 8
30413041
unit: Ry/Bohr
30423042
availability: Numerical atomic orbital basis (not gamma-only algorithm)
30433043
- name: out_mat_xc
@@ -3052,12 +3052,12 @@ parameters:
30523052
availability: Numerical atomic orbital (NAO) and NAO-in-PW basis
30533053
- name: out_mat_xc2
30543054
category: Output information
3055-
type: Boolean
3055+
type: "Boolean \\[Integer\\](optional)"
30563056
description: |
3057-
Whether to print the exchange-correlation matrices in numerical orbital representation: in CSR format in the directory OUT.s.
3057+
Whether to print the exchange-correlation matrices in numerical orbital representation: in CSR format in the directory OUT.${suffix}. The name of the files will be vxcrs1_nao.csr and so on.
30583058
30593059
[NOTE] In the 3.10-LTS version, the file name is Vxc_R_spin$s and so on.
3060-
default_value: "False"
3060+
default_value: False 8
30613061
unit: Ry
30623062
availability: Numerical atomic orbital (NAO) basis
30633063
- name: out_mat_l

0 commit comments

Comments
 (0)