Skip to content

Commit

Permalink
Add assumption to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
unalmis committed Aug 8, 2024
1 parent b31c264 commit f81b791
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion desc/equilibrium/coords.py
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,6 @@ def fixup(x, *args):
)
)
)
# Assume λ=0 for initial guess.
theta_DESC, (res, niter) = vecroot(guess, theta_PEST, rho, zeta)

out = jnp.column_stack([rho, jnp.atleast_1d(theta_DESC.squeeze()), zeta])
Expand Down Expand Up @@ -662,6 +661,9 @@ def get_rtz_grid(
Equilibrium on which to perform coordinate mapping.
radial : ndarray
Sorted unique radial coordinates.
These coordinates are assumed to be a single variable function of rho.
Create a GitHub issue if you have a use-case where this assumption
cannot be made.
poloidal : ndarray
Sorted unique poloidal coordinates.
toroidal : ndarray
Expand Down

0 comments on commit f81b791

Please sign in to comment.