Skip to content

Commit 6e94e9e

Browse files
authored
Fix document description for ocp and ocp_set (#5896)
1 parent 0f89113 commit 6e94e9e

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
@@ -3766,19 +3766,24 @@ These variables are used to control berry phase and wannier90 interface paramete
37663766

37673767
- **Type**: Boolean
37683768
- **Availability**:
3769-
- For PW and LCAO codes. if set to 1, occupations of bands will be setting of "ocp_set".
3770-
- For TDDFT in LCAO codes. if set to 1, occupations will be constrained since second ionic step.
3771-
- For OFDFT, this feature can't be used.
3769+
- For PW and LCAO codes: If set to 1, the band occupations will be determined by `ocp_set`.
3770+
- 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.
3771+
- For OFDFT: This feature is not available.
37723772
- **Description**:
3773-
- True: fix the occupations of bands.
3774-
- False: do not fix the occupations of bands.
3773+
- True: Fixes the band occupations based on the values specified in `ocp_set`.
3774+
- False: Does not fix the band occupations.
37753775
- **Default**: False
37763776

37773777
### ocp_set
37783778

37793779
- **Type**: String
3780-
- **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.
3781-
- **Default**: none
3780+
- **Description**:
3781+
- 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.
3782+
- Example:
3783+
- `1 10*1 0 1` represents occupations for 13 bands, where the 12th band is fully unoccupied (`0`), and all others are occupied (`1`).
3784+
- 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).
3785+
- Incorrect specification of `ocp_set` could lead to inconsistencies in electron counting, causing the calculation to terminate with an error.
3786+
- **Default**: None
37823787

37833788
[back to top](#full-list-of-input-keywords)
37843789

0 commit comments

Comments
 (0)