Skip to content
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.

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

clean up documentation for BPM bond styles #4

Merged
merged 1 commit into from
Jun 8, 2023

Conversation

jibril-b-coulibaly
Copy link

Summary

Form changes on the BPM documentation

Related Issue(s)

  1. break/no remaining
  2. consistency of descriptions with keyword yes / no values
    1. other minor form changes

Author(s)

Jibril B. Coulibaly, Sandia National Laboratories (jibril.coulibaly@gmail.com)

Licensing

By submitting this pull request, I agree, that my contribution will be included in LAMMPS and redistributed under either the GNU General Public License version 2 (GPL v2) or the GNU Lesser General Public License version 2.1 (LGPL v2.1).

Backward Compatibility

OK

Implementation Notes

N/A

Post Submission Checklist

  • The feature or features in this pull request is complete
  • Licensing information is complete
  • Corresponding author information is complete
  • The source code follows the LAMMPS formatting guidelines
  • Suitable new documentation files and/or updates to the existing docs are included
  • The added/updated documentation is integrated and tested with the documentation build system

Further Information, Files, and Links

I think further aesthetic changes could be useful, up to @jtclemm :

  1. detail the formulation of the tangent force and torques in the bpm_rotational docs
  2. Use capital F letters for forces in bpm/rotational, for consistency with bpm/spring
  3. use \cdot instead of \bullet to describe the dot product in damping force
  4. use present term rather than "will be" when describing the effects of options

@jtclemm jtclemm merged commit dc9cefb into jtclemm:BPM Jun 8, 2023
jtclemm pushed a commit that referenced this pull request Jan 12, 2024
Cleaning up and expanding property atom compute
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants