Updated documentation about multipole analysis #432
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mlund
requested changes
May 26, 2023
docs/_docs/analysis.md
Outdated
| `μ ` | Dipole moment | ||
| `μ2 ` | Squared dipole moment | ||
|
|
||
| The capacitance, C, is defined accordingly: |
There was a problem hiding this comment.
"C" --> "C" to make it italic. Same for the other cases.
There was a problem hiding this comment.
Perhaps also add units in the table, i.e. "e", "eÅ"
There was a problem hiding this comment.
Unsure about unit for capacitance, is eV⁻¹ correct?
mlund
approved these changes
May 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added extended documentation about the multipole analysis. Source code not changed, no tests necessary.
Checklist
make testpasses with no errorsthe source code is well documented
new functionality includes unittests
the user-manual has been updated to reflect the changes
I have installed the provided commit hook to auto-format commits (requires
clang-format):code naming scheme follows the convention:
PascalCasecamelCasesnake_case