Skip to content

Commit 971ef1e

Browse files
AsTonyshmentdyzheng
authored andcommitted
Fix document description for ocp and ocp_set (deepmodeling#5896)
1 parent 86ac73e commit 971ef1e

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3518,19 +3518,24 @@ These variables are used to control berry phase and wannier90 interface paramete
35183518

35193519
- **Type**: Boolean
35203520
- **Availability**:
3521-
- For PW and LCAO codes. if set to 1, occupations of bands will be setting of "ocp_set".
3522-
- For TDDFT in LCAO codes. if set to 1, occupations will be constrained since second ionic step.
3523-
- For OFDFT, this feature can't be used.
3521+
- For PW and LCAO codes: If set to 1, the band occupations will be determined by `ocp_set`.
3522+
- For RT-TDDFT in LCAO codes: If set to 1, same as above, but the occupations will be constrained starting from the second ionic step.
3523+
- For OFDFT: This feature is not available.
35243524
- **Description**:
3525-
- True: fix the occupations of bands.
3526-
- False: do not fix the occupations of bands.
3525+
- True: Fixes the band occupations based on the values specified in `ocp_set`.
3526+
- False: Does not fix the band occupations.
35273527
- **Default**: False
35283528

35293529
### ocp_set
35303530

35313531
- **Type**: String
3532-
- **Description**: If ocp is True, the ocp_set is a string to set the number of occupancy, like '1 10 * 1 0 1' representing the 13 band occupancy, 12th band occupancy 0 and the rest 1, the code is parsing this string into an array through a regular expression.
3533-
- **Default**: none
3532+
- **Description**:
3533+
- If `ocp` is set to 1, `ocp_set` must be provided as a string specifying the occupation numbers for each band across all k-points. The format follows a space-separated pattern, where occupations are assigned sequentially to bands for each k-point. A shorthand notation `N*x` can be used to repeat a value `x` for `N` bands.
3534+
- Example:
3535+
- `1 10*1 0 1` represents occupations for 13 bands, where the 12th band is fully unoccupied (`0`), and all others are occupied (`1`).
3536+
- For a system with multiple k-points, the occupations must be specified for all k-points, following their order in the output file kpoints (may lead to fractional occupations).
3537+
- Incorrect specification of `ocp_set` could lead to inconsistencies in electron counting, causing the calculation to terminate with an error.
3538+
- **Default**: None
35343539

35353540
[back to top](#full-list-of-input-keywords)
35363541

0 commit comments

Comments
 (0)