Skip to content

Add new menard scaling plasma geometry and docs#4224

Open
ajpearcey wants to merge 2 commits intomainfrom
i_plasma_geometry_12
Open

Add new menard scaling plasma geometry and docs#4224
ajpearcey wants to merge 2 commits intomainfrom
i_plasma_geometry_12

Conversation

@ajpearcey
Copy link
Copy Markdown
Collaborator

supersedes #4134

@ajpearcey ajpearcey requested a review from a team as a code owner May 6, 2026 10:31
@ajpearcey ajpearcey requested a review from chris-ashe May 6, 2026 10:31
@timothy-nunn timothy-nunn self-assigned this May 6, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 6, 2026

Codecov Report

❌ Patch coverage is 33.33333% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 51.78%. Comparing base (5e0447d) to head (f670573).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
process/models/physics/plasma_geometry.py 33.33% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4224      +/-   ##
==========================================
- Coverage   52.15%   51.78%   -0.37%     
==========================================
  Files         148      150       +2     
  Lines       30435    30204     -231     
==========================================
- Hits        15874    15642     -232     
- Misses      14561    14562       +1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

$$

---------------------------------------------------------------------
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $li(3)$.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The reference is broken

$$

---------------------------------------------------------------------
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $li(3)$.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $li(3)$.
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $l_i(3)$.

[^3]: H. Zohm et al, *'On the Physics Guidelines for a Tokamak DEMO'*,
FTP/3-3, Proc. IAEA Fusion Energy Conference, October 2012, San Diego
[^4]: Menard, J.E. & Brown, T. & El-Guebaly, L. & Boyer, M. & Canik, J. & Colling, Bethany & Raman, Roger & Wang, Z. & Zhai, Yunbo & Buxton, Peter & Covele, B. & D’Angelo, C. & Davis, Andrew & Gerhardt, S. & Gryaznevich, M. & Harb, Moataz & Hender, T.C. & Kaye, S. & Kingham, David & Woolley, R.. (2016). *Fusion nuclear science facilities and pilot plants based on the spherical tokamak.* Nuclear Fusion. 56. 106023. 10.1088/0029-5515/56/10/106023.
[^5] J.E. Menard, S.C. Jardin, S.M. Kaye, C.E. Kessel and J. Manickam (1997) *Ideal MHD stability limits of low aspect ratio tokamak plasmas.* Nuclear Fusion. 37. 595. 10.1088/0029-5515/37/5/I03
Copy link
Copy Markdown
Collaborator

@chris-ashe chris-ashe May 6, 2026

Choose a reason for hiding this comment

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

The reference name could actually be [^menard_1997] to make it easier to know what it is

[^3]: H. Zohm et al, *'On the Physics Guidelines for a Tokamak DEMO'*,
FTP/3-3, Proc. IAEA Fusion Energy Conference, October 2012, San Diego
[^4]: Menard, J.E. & Brown, T. & El-Guebaly, L. & Boyer, M. & Canik, J. & Colling, Bethany & Raman, Roger & Wang, Z. & Zhai, Yunbo & Buxton, Peter & Covele, B. & D’Angelo, C. & Davis, Andrew & Gerhardt, S. & Gryaznevich, M. & Harb, Moataz & Hender, T.C. & Kaye, S. & Kingham, David & Woolley, R.. (2016). *Fusion nuclear science facilities and pilot plants based on the spherical tokamak.* Nuclear Fusion. 56. 106023. 10.1088/0029-5515/56/10/106023.
[^5] J.E. Menard, S.C. Jardin, S.M. Kaye, C.E. Kessel and J. Manickam (1997) *Ideal MHD stability limits of low aspect ratio tokamak plasmas.* Nuclear Fusion. 37. 595. 10.1088/0029-5515/37/5/I03
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can the reference please be in IEEE format with a clickable DOI.
This website should be used: https://www.mybib.com/tools/ieee-citation-generator

# physics_variables.triang is an input
# physics_variables.kappa found from physics_variables.aspect ratio scaling from
# J.E. Menard et al 1997 Nucl. Fusion 37 595 and assume max controllable kappa
# and assume li(3) is held constant
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# and assume li(3) is held constant
# and assume lᵢ(3) is held constant

$$

---------------------------------------------------------------------
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $li(3)$.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I believe the reference of the plot also states that its at a $\langle \beta_p \rangle = 0.5$. Please check this is the case and add it as an assumption into the docs

$$

---------------------------------------------------------------------
- `i_plasma_geometry = 12` -- The elongation is calculated directly from the aspect ratio based on a scaling for the maximum contrallable elongation in a spherical tokamak[^5] and asssuming a constant $li(3)$.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Need a small sentence that triangularity is input

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants