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

Zero rotation nematic #1184

Merged
merged 8 commits into from
Dec 6, 2023
Merged

Zero rotation nematic #1184

merged 8 commits into from
Dec 6, 2023

Conversation

AlainKadar
Copy link
Contributor

Description

Raise a warning when a zero vector is in the orientation list passed to freud.order.Nematic.compute

Motivation and Context

Without this change, if user passes zero vector to compute, they may not realize why the director is incorrect.

How Has This Been Tested?

Test was added to ensure that a warning is raised when the zero vector is passed.

Screenshots

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds or improves functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • I have updated the documentation (if relevant).
  • I have added tests that cover my changes (if relevant).
  • All new and existing tests passed.
  • I have updated the credits.
  • I have updated the Changelog.

@AlainKadar AlainKadar requested a review from a team as a code owner December 4, 2023 22:08
@AlainKadar AlainKadar requested review from Tobias-Dwyer and removed request for a team December 4, 2023 22:08
freud/order.pyx Outdated Show resolved Hide resolved
ChangeLog.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@tommy-waltmann tommy-waltmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, great work on this @AlainKadar !

@tommy-waltmann tommy-waltmann merged commit 44082ac into next Dec 6, 2023
13 checks passed
@tommy-waltmann tommy-waltmann deleted the zero_rotation_nematic branch December 6, 2023 20:24
@tommy-waltmann tommy-waltmann added this to the v3.0.0 milestone Feb 22, 2024
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.

2 participants