New feature: ring Cosserat rods

[armantekinalp]

Ring Cosserat rods will be added with this PR. Ring rods requires a periodic boundary condition at their ends to simulate the effect of closed loop. In order to implement this periodic boundary condition, in backend we modified the memory block and included two additional nodes, elements and voronoi. Position, directors, velocity and omega of these boundary nodes are synched after every kinematic update.

[codecov-commenter]

Codecov Report

Patch coverage: 93.75% and project coverage change: +0.48 🎉

Comparison is base (0ff189f) 87.45% compared to head (e785ab9) 87.93%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@               Coverage Diff                @@
##           update-0.3.1     #229      +/-   ##
================================================
+ Coverage         87.45%   87.93%   +0.48%     
================================================
  Files                41       43       +2     
  Lines              2798     3067     +269     
  Branches            320      354      +34     
================================================
+ Hits               2447     2697     +250     
- Misses              330      341      +11     
- Partials             21       29       +8     

Impacted Files	Coverage Δ
elastica/modules/base_system.py	94.11% <40.00%> (-4.30%)	⬇️
elastica/rod/cosserat_rod.py	97.95% <69.23%> (-2.05%)	⬇️
elastica/memory_block/memory_block_rod.py	97.80% <92.72%> (-2.20%)	⬇️
elastica/dissipation.py	94.28% <93.93%> (-1.17%)	⬇️
elastica/rod/factory_function.py	96.31% <94.78%> (-1.37%)	⬇️
elastica/_synchronize_periodic_boundary.py	100.00% <100.00%> (ø)
elastica/memory_block/memory_block_rigid_body.py	100.00% <100.00%> (ø)
elastica/memory_block/memory_block_rod_base.py	100.00% <100.00%> (ø)
elastica/modules/memory_block.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[armantekinalp]

@ilianasiriziba Can you put the videos of ring rod under gravity simulation here.

[ilianasiriziba]

2D_xy_ring_rod.mp4

2D_xz_ring_rod.mp4

2D_zy_ring_rod.mp4

[skim0119]

I'll start the review.

[armantekinalp]

@bhosale2 please start reviewing.

[bhosale2]

Some work and doubts @armantekinalp. @ilianasiriziba can help out here.

[armantekinalp]

@bhosale2 I have updated documentation please check and see if it make sense.

[bhosale2]

LGTM. @armantekinalp and @ilianasiriziba thanks for all the clarifications and adding this new feature.