Add references for functionals by awvwgk · Pull Request #49 · wavefunction91/ExchCXX · GitHub
Skip to content

Add references for functionals#49

Open
awvwgk wants to merge 1 commit into
wavefunction91:masterfrom
awvwgk:func-docs
Open

Add references for functionals#49
awvwgk wants to merge 1 commit into
wavefunction91:masterfrom
awvwgk:func-docs

Conversation

@awvwgk

@awvwgk awvwgk commented Jan 25, 2026

Copy link
Copy Markdown
  • add literature references for each functional
  • add libxc name and id for each functional

@awvwgk

awvwgk commented Jan 30, 2026

Copy link
Copy Markdown
Author

@awvwgk

awvwgk commented Jan 30, 2026

Copy link
Copy Markdown
Author

Susi @susilehtola is there a good way to link to specific libxc identifiers in the documentation for libxc?

@wavefunction91

Copy link
Copy Markdown
Owner

I'm not opposed to this, but I feel like this is not really a solution to any problem I'm aware of. Libxc already manages its own set of references, I'd prefer that we have one source of truth here.

@susilehtola

Copy link
Copy Markdown
Contributor

The references are coded up in the Libxc implementation. I agree they shouldn't be duplicated and hardcoded in ExchCXX. If you have the functional keywords, you can get the references either from Libxc's func->info or from the website list of functionals.

@awvwgk

awvwgk commented Jan 30, 2026

Copy link
Copy Markdown
Author

I'm not opposed to this, but I feel like this is not really a solution to any problem I'm aware of.

I added those because it was not clear to me which enum corresponds to which combination of exchange and correlation functional. Having a reference point like libxc names or papers helped me to understand what is exposed via which enum.

For example the B97D and B97D3ZERO value are effectively the same functional, but this can only be inferred from the actual implementation. Also, some names deviate from the ones in libxc, like revPBE vs PBE_R, which was not immediately clear to me.

Eventually, I would like to setup GitHub Pages to provide the description provided here in an accessible and searchable way for the users of this library.

@susilehtola

Copy link
Copy Markdown
Contributor

The plan we had with @wavefunction91 years ago was to eventually merge ExchCXX with Libxc, but I guess we both got too busy to act on it. I still think Libxc would benefit from a higher-level interface in addition to what it has at present.

@wavefunction91

Copy link
Copy Markdown
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants