-
Notifications
You must be signed in to change notification settings - Fork 183
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 ELC sample #3468
Fix ELC sample #3468
Conversation
The script was not correct. The ELC method requires a gap region with solid walls to block periodicity along the z-direction.
This recycles the recently deleted visualization_mmm2d.py sample.
This recycles the recently deleted documentation for MMM2D.
Move documentation of class constructor arguments from the reSt files to the corresponding classes docstrings in electrostatics and magnetostatics methods. Add links to Python classes in reSt files and add links to reSt files in the Python docstrings.
This could be reviewed by @biermanncarl. |
Codecov Report
@@ Coverage Diff @@
## python #3468 +/- ##
=======================================
+ Coverage 86% 86% +<1%
=======================================
Files 537 537
Lines 24730 24659 -71
=======================================
- Hits 21340 21333 -7
+ Misses 3390 3326 -64
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I put a just a few suggestions on the content of the documentation in my comments. Everything else seems good to me.
Fixes #3453
Description of changes: