Skip to content

Commit 609f927

Browse files
authored
Docs: update BPCG solver guidance (#7701)
1 parent 18a0da0 commit 609f927

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1152,9 +1152,9 @@
11521152
For plane-wave basis,
11531153

11541154
- cg: The conjugate-gradient (CG) method.
1155-
- bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment.
11561155
- dav: The Davidson algorithm.
11571156
- dav_subspace: The Davidson algorithm without orthogonalization operation, this method is the most recommended for efficiency. `pw_diag_ndim` can be set to 2 for this method.
1157+
- bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment. The BPCG method is currently under testing and is not recommended for use.
11581158

11591159
For numerical atomic orbitals basis,
11601160

docs/parameters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,9 +533,9 @@ parameters:
533533
For plane-wave basis,
534534
535535
* cg: The conjugate-gradient (CG) method.
536-
* bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment.
537536
* dav: The Davidson algorithm.
538537
* dav_subspace: The Davidson algorithm without orthogonalization operation, this method is the most recommended for efficiency. `pw_diag_ndim` can be set to 2 for this method.
538+
* bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment. The BPCG method is currently under testing and is not recommended for use.
539539
540540
For numerical atomic orbitals basis,
541541

source/source_io/module_parameter/read_input_item_elec_stru.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ void ReadInput::item_elec_stru()
5353
For plane-wave basis,
5454
5555
* cg: The conjugate-gradient (CG) method.
56-
* bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment.
5756
* dav: The Davidson algorithm.
5857
* dav_subspace: The Davidson algorithm without orthogonalization operation, this method is the most recommended for efficiency. `pw_diag_ndim` can be set to 2 for this method.
58+
* bpcg: The BPCG method, which is a block-parallel Conjugate Gradient (CG) method, typically exhibits higher acceleration in a GPU environment. The BPCG method is currently under testing and is not recommended for use.
5959
6060
For numerical atomic orbitals basis,
6161

0 commit comments

Comments
 (0)