NWChemEx / NWChemEx/SimDE

MOCharges API Question?

Open
#77 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue question
Dominant language
C++
Stars
0
Forks
0
Avg merge
10h 7m
Merged PRs (30d)
4

Description

Right now (or maybe it's still a WIP?) MOCharges returns a number of centers by number of MOs matrix. The centers used are the ones in from space of the MOs. This could conceivably not be what the caller wants because: e.g., the same center was added to the AO basis set multiple times, there are ghost atoms, and/or there are mid-bond functions. My proposal is:

  • we introduce a class PointSet which is a container of Point objects (this would live in LibChemist)
  • Refactor the Atom class to inherit from PointCharge (related to this issue)
  • Ensure AOBasisSet and Molecule are implicitly convertible to PointSet
  • Have MOCharges take a PointSet instance and a DerivedSpace instance

This allows the caller of MOCharges to specify the centers they care about.

Thoughts? Takers?

Edit: Also I propose the name MOPopulations since AFAIK this is simply counting the number of electrons at a point (the electronic charge would -2 times the matrix returned by this PT for restricted spatial orbitals).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current MOCharges API and how AOBasisSet, Molecule, Atom, and DerivedSpace are represented, then compare the proposed PointSet and Point abstractions with LibChemist. Confirm the intended PointCharge relationship and whether the API should be renamed MOPopulations. Done means callers can explicitly provide the centers and the behavior for repeated, ghost, and mid-bond functions is defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.