Skip to content

Commit

Permalink
Add reference to from_qp_model (#1302)
Browse files Browse the repository at this point in the history
I believe it is from section III of this paper but correct me if I'm
wrong @daniel-dudt : https://arxiv.org/pdf/2211.09829
  • Loading branch information
dpanici authored Oct 16, 2024
2 parents e5d31c2 + 9d89c40 commit 12d9772
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions desc/geometry/surface.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,8 @@ def from_qp_model(
):
"""Create a surface from a near-axis model for quasi-poloidal symmetry.
Model is based off of section III of Goodman et. al. [1]_
Parameters
----------
major_radius : float
Expand All @@ -376,6 +378,11 @@ def from_qp_model(
surface : FourierRZToroidalSurface
Surface with given geometric properties.
References
----------
.. [1] Goodman, Alan, et al. "Constructing Precisely Quasi-Isodynamic
Magnetic Fields." Journal of Plasma Physics 89.5 (2023): 905890504.
"""
assert mirror_ratio <= 1
a = major_radius * np.sqrt(elongation) / aspect_ratio # major axis
Expand Down

0 comments on commit 12d9772

Please sign in to comment.