Feature: polyhedral cross-section current sources and a general VIM formulation of 3-D magnetostatics #2703
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CoronelBuendia
added
the
magnetostatics
CoronelBuendia
changed the title
je-cook
reviewed
Oct 13, 2023
je-cook
reviewed
Oct 13, 2023
|
Kudos, SonarCloud Quality Gate passed!
|
CoronelBuendia
force-pushed
the
matti/polyhedral-prism-fabri
branch
from
9c89448
to
27706d8
Compare
|
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #2703 +/- ##
===========================================
- Coverage 79.97% 79.75% -0.23%
===========================================
Files 222 223 +1
Lines 24755 24986 +231
===========================================
+ Hits 19799 19928 +129
- Misses 4956 5058 +102 ☔ View full report in Codecov by Sentry. |
|
Just fyi this warning needs to be fixed before merge: |
Yeah definitely. It's less trivial though, and I didn't want to do it until we decided to bite the bullet and accept the equal-angle limitation. Will get on it. |
3 tasks
|
CoronelBuendia
changed the title
je-cook
requested changes
Jan 17, 2024
|
also there is still an extra warning lying about: /home/runner/work/bluemira/bluemira/bluemira/magnetostatics/polyhedral_prism.py:323: NumbaPerformanceWarning: np.dot() is faster on contiguous arrays, called on (Array(float64, 1, 'C', False, aligned=True), Array(float64, 1, 'A', False, aligned=True) |
|
and possibly a rebase to bring in the new ruff config |
…2751) * arbitrary planar polyhedral * arbitrary planar polyhedral proper * DRY * 2d ring test with plot and point * added multiple points around circuit for single point test * tidy/remove commented lines * add tests * remove duplication from rebase and alterations to TestPolyhedral2DRing * reduced discretisation to lower run time and tolerance for 2DRing test * addded more points for below coil and changed method of array comparison * marked TestPolyhedral2DRing as longrun * reshuffle tests * reduce runtime and numpy asserts --------- Co-authored-by: CoronelBuendia <matti.coleman@gmail.com>
* add some text * add example python doc * add pic * fix doc * added python doc, pic and text * equal angles examples * modify picture * add note to documentation about limitations * missing word * Add cubic term that was missing in B field equation --------- Co-authored-by: Jonathan Matthews <jonathan.matthews@ukaea.uk> Co-authored-by: kj5248 <115085094+kj5248@users.noreply.github.com>
* make functions private * add __all__ * add note on kernels * first pass JITted source geometry * implement fabbri * reshuffle a little * clean up and JIT utilities * first pass JIT bottura * docstring * make arrays contiguous --------- Co-authored-by: Matti <matti.coleman@ukaea.uk>
CoronelBuendia
force-pushed
the
matti/polyhedral-prism-fabri
branch
from
2834b55
to
81e35f1
Compare
|
je-cook
approved these changes
Jan 24, 2024
This was referenced Jan 24, 2024
OceanNuclear
pushed a commit
that referenced
this pull request
Feb 20, 2024
…ormulation of 3-D magnetostatics (#2703) * baseclasses and housekeeping * pause because PROCESS * 6 hours * write asserts * vector potential * add failing babic test * add singularity protection * add singularity protection * typing * add plotting to Babic Aykel test * baseclass shenanigans * DRY mixin * working arbirtrary geometry * clean up * clean up * kill some list reflection but still not fully JIT * fix signatures * add triangle test * rotate midpoints too * comments and clearer code * add some docstring equations * more docstring equations * parametrise babic aykel test * more source doucmentation * parametrise maths test * remove useless baseclass and make everything private * make more stuff private * make stuff private everywhere * better file docstring * biot savart private points * fix some polyhedral tests * add trapezoidal test * add polyhedral test... that fails too * add polyhedral test... that fails too * add polyhedral test... that fails too * add temporary sanity check * add geometry test * added test to check whether combined shape matching single shape (#2718) * added test to check whether combined shape matching single shape * fix duplication * add teardown method for each class * Add an alternative polyhedral VIM formulation (#2731) * working bottura * get rid of some minuses * kernel start * docstrings * ruff * make tests better written * more maths * fix API documentation * Add `ArbitraryPlanarPolyhedralXSCircuit` (#2704) * add baseclass * arbitrary planar polyhedral * arbitrary planar polyhedral proper * add tests * addplot test * DRY * remove unused zip * rebase and fix circuit tests * fix tests and add error for angles * better error * add vector potential flux test * remove sanity check * docstring change * copyright and remove tools * sonarcloud bug * Add test using ArbitraryPlanarPolyhedralXSCircuit for a 2D ring coil (#2751) * arbitrary planar polyhedral * arbitrary planar polyhedral proper * DRY * 2d ring test with plot and point * added multiple points around circuit for single point test * tidy/remove commented lines * add tests * remove duplication from rebase and alterations to TestPolyhedral2DRing * reduced discretisation to lower run time and tolerance for 2DRing test * addded more points for below coil and changed method of array comparison * marked TestPolyhedral2DRing as longrun * reshuffle tests * reduce runtime and numpy asserts --------- Co-authored-by: CoronelBuendia <matti.coleman@gmail.com> * `PolyhedralPrismCurrentSource` documentation (#2705) * add some text * add example python doc * add pic * fix doc * added python doc, pic and text * equal angles examples * modify picture * add note to documentation about limitations * missing word * Add cubic term that was missing in B field equation --------- Co-authored-by: Jonathan Matthews <jonathan.matthews@ukaea.uk> Co-authored-by: kj5248 <115085094+kj5248@users.noreply.github.com> * code smells * JIT `PolyhedralPrism` even more, and remove reflected lists (#2874) * make functions private * add __all__ * add note on kernels * first pass JITted source geometry * implement fabbri * reshuffle a little * clean up and JIT utilities * first pass JIT bottura * docstring * make arrays contiguous --------- Co-authored-by: Matti <matti.coleman@ukaea.uk> * plt show/close is automatic now * 🎨 Ruff * make tests check symmetry of field * resolve numba warning * trigger ruff * run precommit * fix sonarcloud issue --------- Co-authored-by: kj5248 <115085094+kj5248@users.noreply.github.com> Co-authored-by: Jonathan Matthews <jonathan.matthews@ukaea.uk> Co-authored-by: Matti <matti.coleman@ukaea.uk> Co-authored-by: je-cook <81617086+je-cook@users.noreply.github.com> Co-authored-by: james <james.cook1@ukaea.uk>
OceanNuclear
pushed a commit
that referenced
this pull request
Jun 17, 2024
…ormulation of 3-D magnetostatics (#2703) * baseclasses and housekeeping * pause because PROCESS * 6 hours * write asserts * vector potential * add failing babic test * add singularity protection * add singularity protection * typing * add plotting to Babic Aykel test * baseclass shenanigans * DRY mixin * working arbirtrary geometry * clean up * clean up * kill some list reflection but still not fully JIT * fix signatures * add triangle test * rotate midpoints too * comments and clearer code * add some docstring equations * more docstring equations * parametrise babic aykel test * more source doucmentation * parametrise maths test * remove useless baseclass and make everything private * make more stuff private * make stuff private everywhere * better file docstring * biot savart private points * fix some polyhedral tests * add trapezoidal test * add polyhedral test... that fails too * add polyhedral test... that fails too * add polyhedral test... that fails too * add temporary sanity check * add geometry test * added test to check whether combined shape matching single shape (#2718) * added test to check whether combined shape matching single shape * fix duplication * add teardown method for each class * Add an alternative polyhedral VIM formulation (#2731) * working bottura * get rid of some minuses * kernel start * docstrings * ruff * make tests better written * more maths * fix API documentation * Add `ArbitraryPlanarPolyhedralXSCircuit` (#2704) * add baseclass * arbitrary planar polyhedral * arbitrary planar polyhedral proper * add tests * addplot test * DRY * remove unused zip * rebase and fix circuit tests * fix tests and add error for angles * better error * add vector potential flux test * remove sanity check * docstring change * copyright and remove tools * sonarcloud bug * Add test using ArbitraryPlanarPolyhedralXSCircuit for a 2D ring coil (#2751) * arbitrary planar polyhedral * arbitrary planar polyhedral proper * DRY * 2d ring test with plot and point * added multiple points around circuit for single point test * tidy/remove commented lines * add tests * remove duplication from rebase and alterations to TestPolyhedral2DRing * reduced discretisation to lower run time and tolerance for 2DRing test * addded more points for below coil and changed method of array comparison * marked TestPolyhedral2DRing as longrun * reshuffle tests * reduce runtime and numpy asserts --------- Co-authored-by: CoronelBuendia <matti.coleman@gmail.com> * `PolyhedralPrismCurrentSource` documentation (#2705) * add some text * add example python doc * add pic * fix doc * added python doc, pic and text * equal angles examples * modify picture * add note to documentation about limitations * missing word * Add cubic term that was missing in B field equation --------- Co-authored-by: Jonathan Matthews <jonathan.matthews@ukaea.uk> Co-authored-by: kj5248 <115085094+kj5248@users.noreply.github.com> * code smells * JIT `PolyhedralPrism` even more, and remove reflected lists (#2874) * make functions private * add __all__ * add note on kernels * first pass JITted source geometry * implement fabbri * reshuffle a little * clean up and JIT utilities * first pass JIT bottura * docstring * make arrays contiguous --------- Co-authored-by: Matti <matti.coleman@ukaea.uk> * plt show/close is automatic now * 🎨 Ruff * make tests check symmetry of field * resolve numba warning * trigger ruff * run precommit * fix sonarcloud issue --------- Co-authored-by: kj5248 <115085094+kj5248@users.noreply.github.com> Co-authored-by: Jonathan Matthews <jonathan.matthews@ukaea.uk> Co-authored-by: Matti <matti.coleman@ukaea.uk> Co-authored-by: je-cook <81617086+je-cook@users.noreply.github.com> Co-authored-by: james <james.cook1@ukaea.uk>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Linked Issues
Closes #1816 (almost)
This is useful for STEP, in that arbitrary cross-section conductors can be used, but I was interested in this stuff because I needed a general way to do volume integrals to calculate things like vector potential, and then self-inductance, etc. It's also potentially useful for stellarators, in that the conductors no longer need to be planar.
UPDATE (matti): As discussed 11/12 with the STEP team, at present we have only been successful in implementing a VIM method for arbitrary cross-sections with div J = 0 (equal end-cap angles). As it is possible to model their desired geometry using such a source term, I will update this feature branch to bring in an equal-angle VIM formulation with the necessary caveats. At a later date, and if a suitable implementation can be developed, we can replace it with a more general formulation.
Description
Adds
PolyhedralPrismCurrentSourcewhere you specify a set of x-zCoordinatesrather than rectangular dimensions.I've benchmarked results against the
RectangularPrismCurrentSource, and it is a mixed bag:More generally, the formulation does allow for arbitrary construction of conducting geometry, and we may want to provide a mesh interface for this volume integral approach
NOTE:
RectangularPrismCurrentSourcewill stay alive for the foreseeable future. It's considerably faster. I have yet to fully JIT the polyhedral one because of reflected list issues, but I did performance benchmark a fully JIT-ed version of the polyhedral stuff for n=4 (dodging list reflection) and it is still much, much slower.Interface Changes
Checklist
I confirm that I have completed the following checks:
pytest tests --reactorpre-commit run --from-ref develop --to-ref HEADsphinx-build -W documentation/source documentation/build