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.

Sign up for GitHub

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

Jump to bottom

Memory block refactor #296

Merged
merged 19 commits into from
Sep 8, 2023
Merged

Memory block refactor #296

merged 19 commits into from
Sep 8, 2023

Conversation

sy-cui
Copy link
Contributor

@sy-cui sy-cui commented Sep 7, 2023

Refactor memory block implementation:

  • Add _map_system_properties_to_block_memory method for both Cosserat rod and rigid bodies memory blocks to avoid code repetition.
  • Slight modifications in make_block_memory_metadata function without change in functionality
  • Minor changes in function naming and docstrings

Test suites for memory blocks:

  • Add test cases for make_block_memory_metadata() and make_block_memory_periodic_boundary_metadata()
  • Add test cases for rigid-body memory block logic and implementation
  • Add test cases for Cosserat rod memory block logic and implementation (ring rod supported)

sy-cui added 18 commits September 4, 2023 18:38
@sy-cui
refactor: modify implementation of make_block_memory_metadata functio…
8d34e7b 
…n without changing behavior, and add docs, type hints, test cases
@sy-cui
feat: test_memory_block for straight rods. Modify BaseRodForTesting d…
41ad249 
…irector to avoid nan curvatures
@sy-cui
refactor: remove custom marker from test_make_block_memory_metadata
896a1da
@sy-cui
refactor: rename test_memory_block to test_memory_block_cosserat_rod …
4cf74fb 
…and modify __doc__ to include only rods
@sy-cui
refactor: prepend underscores '_' to initialization functions, and mo…
2bccd08 
…dify rate function implementation
@sy-cui
fix: fix rate collection indexing
47f5884
@sy-cui
test: add self check to test_memory_block_rod_straight_rods
63866b7
@sy-cui
refactor: add mapping helper function in memory block to avoid code r…
f0610c0 
…epetition
@sy-cui
refactor: replace np.all(. == .) assertion with np.testing.assert_arr…
b8c7ba6 
…ay_equal
@sy-cui
test: test_make_block_memory_periodic_boundary_metadata
503186f
@sy-cui
test: test_memory_block_rod_straight_rod now also test ring rods, and…
9c32387 
… is renamed to test_memory_block_rod
@sy-cui
chore: restructure if statement in memory_block_rod.py to avoid code …
4b76c3f 
…repetition
@sy-cui
refactor: switch self-check and cross-check order
d977a32
@sy-cui
refactor: change type hints and doc string
bcf3aa9
@sy-cui
test: test cases for rigid body memory block
4dfeb88
@sy-cui
docs: add docstring to test_memory_block_rod
f9d83d3
@sy-cui
test: add more parameterized number of rigid bodies into test
854898d
@sy-cui
refactor: add mapping function to memory_block_rigid_body to avoid co…
c6aeb21 
…de repetition
@sy-cui sy-cui added enhancement New feature or request prio:low Priority level: low refactor Refactor existing features labels Sep 7, 2023
@sy-cui sy-cui added this to the Version 0.3.2 milestone Sep 7, 2023
@sy-cui sy-cui self-assigned this Sep 7, 2023
@codecov-commenter
Copy link

Codecov Report

Patch coverage is 93.10% of modified lines.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files Changed Coverage
elastica/memory_block/memory_block_rigid_body.py 91.66%
elastica/memory_block/memory_block_rod.py 92.72%
elastica/memory_block/memory_block_rod_base.py 100.00%

📢 Thoughts on this report? Let us know!.

armantekinalp
armantekinalp approved these changes Sep 8, 2023
View reviewed changes
Copy link
Contributor

@armantekinalp armantekinalp left a comment

Choose a reason for hiding this comment

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

LGTM, nice work!

@armantekinalp armantekinalp merged commit 4340ace into GazzolaLab:update-0.3.2 Sep 8, 2023
@sy-cui sy-cui deleted the memory_block_refactor branch October 5, 2023 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@armantekinalp armantekinalp armantekinalp approved these changes

Assignees

@sy-cui sy-cui

Labels
enhancement New feature or request prio:low Priority level: low refactor Refactor existing features
Projects
None yet
Milestone
Version 0.3.2
Development

Successfully merging this pull request may close these issues.
3 participants
@sy-cui @codecov-commenter @armantekinalp