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 dplr: set the positions of WCs to those of the real atoms in end_of_step #4084

Draft
wants to merge 4 commits into
base: devel
Choose a base branch
from

Conversation

Yi-FanLi
Copy link
Collaborator

@Yi-FanLi Yi-FanLi commented Aug 28, 2024

Thie PR aims at fixing #3679.

Fix dplr assumes that the WCs exacts reside on the positions of the real atoms at the end of each step, and assigns the positions of the WCs according to the output of the DeepTensor models.

The current implementation sets the positions of WCs to the positions of real atoms in the post_integrate function. As a result, get_valid_pairs will raise error when using a restart file.

This PR fixes this issue. Instead of residing the WCs on real atoms in post_integrate, it does so in the end_of_step function.

Summary by CodeRabbit

  • New Features
    • Introduced a new method for setting up pre-exchange operations, enhancing simulation lifecycle management.
  • Changes
    • Renamed the post_integrate method to pre_exchange to better reflect its role in the simulation process.
    • Updated mask settings to improve clarity and context within the simulation lifecycle.
  • Chores
    • Updated ownership context for Docker image in the build workflow configuration.

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

Walkthrough

The changes involve renaming the post_integrate() method to pre_exchange() in the FixDPLR class, updating its associated mask from POST_INTEGRATE to PRE_EXCHANGE, and introducing a new method setup_pre_exchange(). Additionally, the GitHub Actions workflow has been modified to reflect a change in the repository owner for building and pushing a Docker image.

Changes

Files Change Summary
source/lmp/fix_dplr.cpp Renamed post_integrate() to pre_exchange(), changed mask from POST_INTEGRATE to PRE_EXCHANGE, and added setup_pre_exchange().
source/lmp/fix_dplr.h Renamed post_integrate() to pre_exchange() in class declaration and added setup_pre_exchange().
.github/workflows/build_wheel.yml Updated Docker image ownership from deepmodeling to Yi-FanLi in the workflow configuration.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54b53df and c4328e6.

Files selected for processing (2)
  • source/lmp/fix_dplr.cpp (4 hunks)
  • source/lmp/fix_dplr.h (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • source/lmp/fix_dplr.cpp
  • source/lmp/fix_dplr.h

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@Yi-FanLi Yi-FanLi marked this pull request as draft August 28, 2024 06:05
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: 0

Outside diff range, codebase verification and nitpick comments (2)
source/lmp/fix_dplr.h (1)

47-47: Incomplete Renaming Detected

The method post_integrate() is still being referenced in source/lmp/fix_dplr.cpp. Please ensure that all occurrences of post_integrate() are updated to end_of_step() to maintain consistency across the codebase.

  • File: source/lmp/fix_dplr.cpp
  • Line: Reference found in min_pre_exchange() method.
Analysis chain

Method Renaming Approved

The renaming of post_integrate() to end_of_step() is appropriate for the described functionality. Ensure that all references to this method in the codebase are updated accordingly.

The code changes are approved.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all references to `post_integrate` are updated to `end_of_step`.

# Test: Search for the old function name. Expect: No occurrences.
rg --type cpp -A 5 $'post_integrate'

Length of output: 375

source/lmp/fix_dplr.cpp (1)

402-402: Incomplete Renaming Detected

The function post_integrate is still being referenced in the min_pre_exchange method within source/lmp/fix_dplr.cpp. Please update all occurrences of post_integrate to end_of_step to ensure consistency and prevent potential errors.

  • File: source/lmp/fix_dplr.cpp
  • Line: void FixDPLR::min_pre_exchange() { post_integrate(); }
Analysis chain

Method Implementation and Renaming Approved

The implementation of end_of_step() correctly updates the WC positions as intended. Ensure that all references to this method in the codebase are updated accordingly.

The code changes are approved.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all references to `post_integrate` are updated to `end_of_step`.

# Test: Search for the old function name. Expect: No occurrences.
rg --type cpp -A 5 $'post_integrate'

Length of output: 375

Copy link

codecov bot commented Aug 28, 2024

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.

Project coverage is 80.37%. Comparing base (24e1167) to head (c4328e6).
Report is 1 commits behind head on devel.

Files with missing lines Patch % Lines
source/lmp/fix_dplr.cpp 0.00% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4084      +/-   ##
==========================================
- Coverage   83.01%   80.37%   -2.64%     
==========================================
  Files         524      524              
  Lines       51639    51627      -12     
  Branches     3030     3030              
==========================================
- Hits        42867    41497    -1370     
- Misses       7825     9333    +1508     
+ Partials      947      797     -150     

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

@njzjz njzjz linked an issue Aug 28, 2024 that may be closed by this pull request
@Yi-FanLi Yi-FanLi closed this Aug 28, 2024
@Yi-FanLi Yi-FanLi reopened this Aug 28, 2024
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.

LAMMPS fix dplr issue
1 participant