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

fix(cc): copy nloc atoms from neighbor list #4459

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Dec 7, 2024

Prevent that the size of the neighbor list is larger than nloc.

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility in copying neighbor list data with the addition of a natoms parameter.
    • Improved handling of neighbor list data in the compute methods across multiple classes.
  • Bug Fixes

    • Refined error handling in the translate_error method for better clarity on exceptions.
  • Documentation

    • Updated method documentation to reflect changes in parameters and usage.
  • Style

    • Adjusted code structure for better readability and maintainability.

Prevent that the size of neighbor list is larger than nloc.

Signed-off-by: Jinzhe Zeng <[email protected]>

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (5)
  • source/api_cc/include/common.h: Language not supported
  • source/api_cc/src/DeepPotJAX.cc: Language not supported
  • source/api_cc/src/DeepPotPT.cc: Language not supported
  • source/api_cc/src/DeepSpinPT.cc: Language not supported
  • source/api_cc/src/common.cc: Language not supported
@github-actions github-actions bot added the C++ label Dec 7, 2024
Copy link
Contributor

coderabbitai bot commented Dec 7, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to several classes and methods related to neighbor list data management in the codebase. The copy_from_nlist method in NeighborListData now accepts an additional parameter, natoms, allowing for more flexible copying of atom data. The compute methods in DeepPotJAX, DeepPotPT, and DeepSpinPT classes have been updated to accommodate new parameters for neighbor list handling, enhancing their functionality. Additionally, error handling improvements have been made in the translate_error methods across these classes.

Changes

File Change Summary
source/api_cc/include/common.h Updated copy_from_nlist method signature to include natoms parameter. Documentation updated to reflect changes.
source/api_cc/src/DeepPotJAX.cc Modified compute method overloads to include const InputNlist& lmp_list and const int& ago. Adjusted logic for neighbor list data handling and added padding logic for input data structures.
source/api_cc/src/DeepPotPT.cc Updated compute method signature to include nall - nghost in copy_from_nlist call. Enhanced error handling in translate_error method. Adjusted control flow in init method to ensure single initialization.
source/api_cc/src/DeepSpinPT.cc Enhanced translate_error method to catch additional exception types. Modified compute method to include nall - nghost in copy_from_nlist call. Updated computew methods to call modified compute method correctly.
source/api_cc/src/common.cc Updated copy_from_nlist method signature to include const int natoms. Added template instantiations for select_by_type and select_real_atoms methods for double and float types.

Possibly related PRs

Suggested labels

Core, C++, LAMMPS

Suggested reviewers

  • wanghan-iapcm
  • iProzd

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
source/api_cc/include/common.h (1)

36-42: Clarify documentation for copy_from_nlist method

The updated documentation effectively explains the new natoms parameter. To enhance readability, consider combining the parameter description into a single line.

Apply this diff to adjust the documentation:

 /**
  * @brief Copy the neighbor list from an InputNlist.
- * @param[in] inlist The input neighbor list.
- * @param[in] natoms The number of atoms to copy. If natoms is -1, copy all
- * atoms.
+ * @param[in] inlist The input neighbor list.
+ * @param[in] natoms The number of atoms to copy. If natoms is -1, copy all atoms.
  */
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ce9aeb3 and c0e2033.

📒 Files selected for processing (5)
  • source/api_cc/include/common.h (1 hunks)
  • source/api_cc/src/DeepPotJAX.cc (1 hunks)
  • source/api_cc/src/DeepPotPT.cc (1 hunks)
  • source/api_cc/src/DeepSpinPT.cc (1 hunks)
  • source/api_cc/src/common.cc (1 hunks)
🔇 Additional comments (3)
source/api_cc/src/DeepPotPT.cc (1)

172-172: Correct usage of updated copy_from_nlist method

The addition of nall - nghost as the second parameter to copy_from_nlist aligns with the updated method signature and ensures that only the relevant atoms are copied. This change enhances the accuracy of neighbor list management.

source/api_cc/src/DeepPotJAX.cc (1)

569-569: Proper implementation of copy_from_nlist with new parameter

Including nall - nghost as the second argument in nlist_data.copy_from_nlist(lmp_list, nall - nghost); correctly adapts the method call to the updated signature. This ensures appropriate handling of neighbor list data based on the number of atoms.

source/api_cc/src/DeepSpinPT.cc (1)

180-180: Consistent application of updated copy_from_nlist method

By passing nall - nghost to copy_from_nlist, the code accurately reflects the updated method signature and ensures that neighbor list data is correctly managed for the local atoms.

source/api_cc/src/common.cc Show resolved Hide resolved
Copy link

codecov bot commented Dec 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.75%. Comparing base (ce9aeb3) to head (c0e2033).
Report is 3 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4459   +/-   ##
=======================================
  Coverage   83.75%   83.75%           
=======================================
  Files         667      667           
  Lines       61518    61517    -1     
  Branches     3486     3486           
=======================================
  Hits        51526    51526           
+ Misses       8866     8865    -1     
  Partials     1126     1126           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Dec 9, 2024
Merged via the queue into deepmodeling:devel with commit ec3b83f Dec 9, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants