Skip to content

Commit

Permalink
Add notation to list of variables that by default derivative is in rh…
Browse files Browse the repository at this point in the history
…o, theta, zeta
  • Loading branch information
unalmis committed Jul 20, 2024
1 parent 14c0354 commit 7ae8ad1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/write_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ def write_csv(parameterization):
The keyword argument ``basis='xyz'`` can be used to convert the variables into Cartesian
coordinates :math:`(X,Y,Z)`. ``basis`` must be one of ``{'rpz', 'xyz'}``.
Our convention to denote partial derivatives is an underscore followed by the first
letter of the coordinate that the partial derivative is taken with respect to. Unless
otherwise specified or implied by the variable name, these partial derivatives are
the partial derivatives of the DESC coordinate system. For example, ``|B|_z`` is
:math:`(\partial\vertB\vert / \partial\zeta)|_{\rho, \theta}`.
"""

block = """
Expand Down

0 comments on commit 7ae8ad1

Please sign in to comment.