Skip to content

Ke precond threading doc #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JacekDziedzic merged 3 commits into from
Jan 18, 2026
Merged

Ke precond threading doc #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c930f1e
Update recip_precond, add threads_precond description.
Chengcheng-Xiao Jan 17, 2026
707dc1e
Typo fix.
Chengcheng-Xiao Jan 17, 2026
dfbfc21
update copy right year.
Chengcheng-Xiao Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# General information about the project.
project = 'ONETEP Documentation'
copyright = '2022-2025, ONETEP Developers\' Group'
copyright = '2022-2026, ONETEP Developers\' Group'
author = 'ONETEP Developers\' Group: Jacek Dziedzic, Peter Haynes, Nicholas Hine, Arash Mostofi, Mike Payne, and Chris-Kriton Skylaris.'

# The version info for the project you're documenting, acts as replacement for
Expand Down
7 changes: 5 additions & 2 deletions recip_precond.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,8 @@ Keywords
energy expectation value? (requires ``k_zero`` to be negative).

- ``precond_array_type`` [Basic, string, default ``KT``\ ] The type of kinetic
energy to use for NGWF-specific preconditioning. Options are: `KT`, `INVST`,
and `T`. (requires ``precond_array`` to be ``T``).
energy to use for NGWF-specific preconditioning. Options are: ``KT``, ``INVST``,
and ``T``. (requires ``precond_array`` to be ``T``).

- ``threads_precond`` [Basic, int, default same as ``threads_num_fftboxes``] How many threads to use for batch preconditioning.
When ``precond_array=T``, the bigger ``threads_precond`` the more memory is required.