Add WFN-history backend for Gamma-only NAO calculations#7442
Add WFN-history backend for Gamma-only NAO calculations#7442Growl1234 wants to merge 19 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds Gamma-only LCAO wavefunction-history extrapolation (use_prev_wf) by snapshotting the previous step’s coefficients and reorthonormalizing them against the current overlap matrix before SCF.
Changes:
- Introduces LCAO wavefunction snapshot/history helpers and a Gamma-only reorthonormalization routine.
- Wires extrapolation into the LCAO ESolver flow and adds
wfc_extrapinput validation/handling (including skipping charge extrapolation when enabled). - Updates CMake to enforce a minimum C++ standard and adds a new
module_extrapsubdirectory target.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| source/source_lcao/module_extrap/wf_snapshot_lcao.h | Stores/restores full Psi coefficient snapshots plus occupations. |
| source/source_lcao/module_extrap/wf_orthonormalize_lcao.h | Declares Gamma-only reorthonormalization API + diagnostic result struct. |
| source/source_lcao/module_extrap/wf_orthonormalize_lcao.cpp | Implements MPI-aware assembly + Cholesky-based reorthonormalization. |
| source/source_lcao/module_extrap/wf_history_lcao.h | Defines wavefunction history class and apply-result diagnostics. |
| source/source_lcao/module_extrap/wf_history_lcao.cpp | Implements history management and use_prev_wf apply path. |
| source/source_lcao/module_extrap/wf_extrap_method.h | Adds extrapolation method/status enums and string conversions. |
| source/source_lcao/module_extrap/CMakeLists.txt | Adds lcao_extrap object library target for new module sources. |
| source/source_lcao/CMakeLists.txt | Enables module_extrap subdir and adds new sources to LCAO objects list. |
| source/source_io/module_parameter/read_input_item_system.cpp | Adds wfc_extrap input item, docs, and validation checks. |
| source/source_io/module_parameter/input_parameter.h | Adds wfc_extrap parameter with default "none". |
| source/source_esolver/esolver_ks_lcao.h | Adds wf_history_lcao_ member to ESolver. |
| source/source_esolver/esolver_ks_lcao.cpp | Initializes history, prepares overlap early, applies extrapolation, rebuilds density, updates history after SCF. |
| source/source_esolver/esolver_fp.cpp | Skips charge extrapolation when wfc_extrap is enabled (LCAO, istep>0). |
| CMakeLists.txt | Enforces a minimum C++ standard globally (now 14). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ddc1a25 to
375f25c
Compare
1fe84e8 to
8e662df
Compare
276a700 to
3faaf27
Compare
|
Thank you for your pull request. This PR presents a creative idea, and we are open to merging it, yet several issues need to be discussed first: |
|
Thank you for reviewing!
Those code is most likely for debugging and finding errors. Once further validation from maintainer's side is done, they could be considered dropped. |
This is not intended to introduce a "creative algorithm" or any "new method". It just implements the basic, lowest-order wavefunction-history initialization referred to as This basic idea is already used, in various forms, in many quantum-chemistry and electronic-structure packages, including Gaussian, ORCA, and CP2K. In particular, the CP2K implementation was the direct motivation for introducing this capability in ABACUS. Its Moreover, this low-level capability is also a necessary foundation for introducing formally published higher-order wavefunction-extrapolation methods, such as |
For the current Gamma-only NAO benchmark, the WFN-based initialization reduces the total number of SCF iterations from 44 to 35 and reduces the total runtime from about 32.7 s to 28.2 s, while preserving the final result. This is the result from small-cell test, but if tested with large cells, the improvements should be more significant. That said, since it is not yet implemented with k-points, this PR should not be regarded as broadly applicable or as demonstrating general performance improvements across all ABACUS workflows. |
I agree with this point. The current implementation leaves too much WFN-specific logic in Btw, the diagnostics part in the implementation most likely can be dropped. |
655bd29 to
daae910
Compare
|
It seems moving specific logic from |
This PR introduces an optional WFN-based initialization path for NAO calculations.
A new
wfc_extrap use_prev_wfpath is added. It stores the converged wavefunction from the previous ionic step, rebuilds the current overlap matrix, reorthonormalizes the previous wavefunction with the current overlap matrix, and then reconstructs the density matrix and charge density before entering the normal SCF cycle. When this path is enabled, the existing charge-density extrapolation is skipped, so the initial density is generated from the WFN-history backend instead of being extrapolated directly in real space.The implementation currently focuses on the Gamma-only backend, including MPI-distributed matrices. This is intended as a common backend for future improvements and more WFN-based predictors such as ASPC and GExt_PROJ.
Here's a simple test that shows the accuracy and effectiveness of the WFN-based path: test.zip. The regtesting is left for a next commit.
Still missing:
What's planned in the future:
Details
Linked Issue
None
Unit Tests and/or Case Tests for my changes
02_NAO_Gamma/relax_wfc_extrapExact Verification Performed
What's changed?
Governance Checklist
GlobalV,GlobalC, orPARAMcode references, or exception requested below with reason, scope, risk, and cleanup plan..hpppropagation, or rationale provided below..batand.cmduse CRLF.source/CMakeLists.txt, or rationale provided below.@coderabbitai review.INPUT Parameter Changes
wfc_extrap none/use_prev_wfdocs/parameters.yamlupdated: not yetdocs/advanced/input_files/input-main.mdupdated: not yetCore Module Impact
Governance Exception