FLUX-SURFACE GEOMETRY

Clebsch coordinates

GYRO/CGYRO/NEO use a right-handed (positively-oriented), field-aligned coordinate system $(r,\theta ,\alpha )$ and the Clebsch field representation [KK58]

$$\mathbf{B}=\mathrm{\nabla }\alpha \times \mathrm{\nabla }\psi \text{such that}\mathbf{B}\cdot \mathrm{\nabla }\alpha =\mathbf{B}\cdot \mathrm{\nabla }\psi =0$$

where $\psi$ is the poloidal flux divided by $2\pi$ and

$$\alpha =\phi +\nu (r,\theta )$$

is the Clebsch angle. Here, $\phi$ is the toroidal angle, oriented as shown in the figure below, and $\theta$ is the poloidal angle which increases as one moves counterclockwise along the flux-surface (shown in blue). In these coordinates, the Jacobian is

$${\mathcal{J}}_{\psi }\doteq \frac{1}{\mathrm{\nabla }\psi \times \mathrm{\nabla }\theta \cdot \mathrm{\nabla }\alpha }=\frac{1}{\mathrm{\nabla }\psi \times \mathrm{\nabla }\theta \cdot \mathrm{\nabla }\phi }.$$

Since the coordinates $(\psi ,\theta ,\alpha )$ and $(\psi ,\theta ,\phi )$ form right-handed systems, the Jacobian ${\mathcal{J}}_{\psi }$ is positive-definite. In the latter coordinates, the magnetic field becomes

$$\mathbf{B}=\mathrm{\nabla }\phi \times \mathrm{\nabla }\psi +\frac{\partial \nu }{\partial \theta }\mathrm{\nabla }\theta \times \mathrm{\nabla }\psi$$

Using the definition of the safety factor, $q(\psi )$, we may deduce

$$q(\psi )\doteq \frac{1}{2\pi }{\int }_0^{2\pi }\frac{\mathbf{B}\cdot \mathrm{\nabla }\phi }{\mathbf{B}\cdot \mathrm{\nabla }\theta }d\theta =\frac{1}{2\pi }{\int }_0^{2\pi }(-\frac{\partial \nu }{\partial \theta })d\theta =\frac{\nu (\psi ,0)-\nu (\psi ,2\pi )}{2\pi }.$$

$$$$

For concreteness, we choose the following boundary conditions for $\nu$:

$$\begin{array}{rl}\nu (\psi ,2\pi )=& -2\pi q(\psi ),\\ \nu (\psi ,0)=& 0.\end{array}$$

By writing $\mathbf{B}$ in the standard form

$$\mathbf{B}=\mathrm{\nabla }\phi \times \mathrm{\nabla }\psi +I(\psi )\mathrm{\nabla }\phi ,$$

we can derive the following integral for $\nu$:

$$\nu (\psi ,\theta )=-I(\psi ){\int }_0^{\theta }{\mathcal{J}}_{\psi }{\left|\mathrm{\nabla }\phi \right|}^{2}d\theta .$$

In the case of concentric (unshifted) circular flux surfaces, one will obtain the approximate result $\nu (\psi ,\theta )\sim -q(\psi )\theta$. Finally, we remark that the coordinate systems $(R,Z,\phi )$ and $(r,\theta ,\phi )$ are positively oriented.

Bounding-box method

In the MXH parameterization [ACB20], we use the bounding-box method to define

• minor radius $r$

• major radius $R_0$

• elongation $\kappa$

• elevation $Z_0$

via the flux-surface contour extrema

$$\begin{array}{rl}2r=& \underset{\ell }{max}(R)-\underset{\ell }{min}(R),\\ 2\kappa r=& \underset{\ell }{max}(Z)-\underset{\ell }{min}(Z),\\ 2R_0=& \underset{\ell }{max}(R)+\underset{\ell }{min}(R),\\ 2Z_0=& \underset{\ell }{max}(Z)+\underset{\ell }{min}(Z).\end{array}$$

Effective field

The effective field strength, $B_{\mathrm{u}\mathrm{n}\mathrm{i}\mathrm{t}}$, is defined as

$$B_{\mathrm{unit}}=\frac{1}{r}\frac{d{\chi }_t}{dr},$$

where ${\chi }_t$ is the toroidal flux divided by $2\pi$. This gives the roughly equivalent field that would be obtained if the flux surface was deformed to a circle.

Equilibria

GYRO/CGYRO/NEO can be run using circular equilibrium or shaped Grad-Shafranov equilibrium.

(1) Circular equilibrium

The flux surfaces, which are not local G-S equilibria, have the form:

$$\begin{array}{rl}R(r,\theta )& =R_0+r\cos \theta \\ Z(r,\theta )& =r\sin \theta \end{array}$$

where $\nu (r,\theta )=-q(r)\theta$.

• CGYRO: EQUILIBRIUM_MODEL = 1

• NEO: EQUILIBRIUM_MODEL = 0

(2) Shaped Grad-Shafranov equilibrium

The flux surfaces, which are local G-S equilibria, have the new MXH3 parameterization [ACB20]:

$$\begin{array}{rl}R(r,\theta )& =R_0(r)+r\cos {\theta }_R\\ Z(r,\theta )& =Z_0(r)+\kappa (r)r\sin \theta \end{array}$$

where $\nu (r,\theta )$ is computed numerically. The harmonic angle ${\theta }_R$ is

$${\theta }_R=\theta +c_0(r)+\sum _{n=1}^3[c_n(r)\cos n\theta +s_n(r)\sin n\theta ]$$

• $c_n$ are anti-symmetric moments and $s_n$ are symmetric moments.

• CGYRO: EQUILIBRIUM_MODEL = 2

• NEO: EQUILIBRIUM_MODEL = 2 or PROFILE_EQUILIBRIUM_MODEL = 1

• For experimental profiles, shape parameters are auto-generated from profile data.

Table of geometry parameters

Symbol	input.cgyro parameter	input.neo parameter	meaning
$r/a$	RMIN	RMIN_OVER_A	minor radius
$R_0(r)/a$	RMAJ	RMAJ_OVER_A	major radius
$\partial R_0/\partial r$	SHIFT	SHIFT	Shafranov shift
$Z_0(r)/a$	ZMAG	ZMAG_OVER_A	elevation
$\partial Z_0/\partial r$	DZMAG	S_ZMAG	elevation shift
$q$	Q	Q	safety factor
$s$	S	SHEAR	shear
$\kappa$	KAPPA	KAPPA	elongation
$s_{\kappa }$	S_KAPPA	S_KAPPA
$\delta =\sin s_1$	DELTA	DELTA	triangularity
$s_{\delta }$	S_DELTA	S_DELTA
$\zeta =-s_2$	ZETA	ZETA	squareness
$s_{\zeta }$	S_ZETA	S_ZETA
$c_0$	SHAPE_COS0	SHAPE_COS0	tilt
$s_{c_0}$	SHAPE_S_COS0	SHAPE_S_COS0
$c_1$	SHAPE_COS1	SHAPE_COS1	ovality
$s_{c_1}$	SHAPE_S_COS1	SHAPE_S_COS1
$c_2$	SHAPE_COS2	SHAPE_COS2
$s_{c_2}$	SHAPE_S_COS2	SHAPE_S_COS2
$c_3$	SHAPE_COS3	SHAPE_COS3
$s_{c_3}$	SHAPE_S_COS3	SHAPE_S_COS3
$s_3$	SHAPE_SIN3	SHAPE_SIN3
$s_{s_3}$	SHAPE_S_SIN3	SHAPE_S_SIN3
${\beta }_e$	BETAE_UNIT	NA
${\beta }_{\ast }$ scaling	BETA_STAR_SCALE	BETA_STAR
BTCCW	BTCCW	BTCCW
IPCCW	IPCCW	IPCCW

For further information about geometry and normalization conventions, consult the GYRO Technical Guide [CB10].

Magnetic field orientation

GACODE uses a right-handed (positively-oriented), field-aligned coordinate system $(r,\theta ,\phi )$, whereas DIII-D uses a (positively-oriented) cylindrical system $(R,\varphi ,Z)$. Looking down on the tokamak from above, the orientation of the GACODE toroidal angle is clockwise, whereas the DIII-D toroidal angle is counter-clockwise:

In reality, quantities like the safety factor and poloidal flux have definite signs. Historically, these signs have been suppressed or neglected in both theory and modeling. For proper treatment of momentum transport, however, these signs must be retained. We can infer typically neglected signs by knowing IPCCW and BTCCW. For example:

• sign($B_{\mathrm{t}\mathrm{o}\mathrm{r}}$) = -BTCCW

• sign($B_{\mathrm{p}\mathrm{o}\mathrm{l}}$) = -IPCCW

• sign(${\psi }_{\mathrm{p}\mathrm{o}\mathrm{l}}$) = -IPCCW

• sign($q$) = IPCCW $\times$ BTCCW

The standard configuration in DIII-D is shown below.

This corresponds to IPCCW = 1 and BTCCW =-1. Thus, in GACODE coordinates, we expect:

• sign($B_{\mathrm{t}\mathrm{o}\mathrm{r}}$) = 1

• sign($B_{\mathrm{p}\mathrm{o}\mathrm{l}}$) = -1

• sign(${\psi }_{\mathrm{p}\mathrm{o}\mathrm{l}}$) = -1

• sign($q$) = -1

In other words, the safety factor and poloidal flux are negative in the typical case. This will be reflected in a properly-constructed input.gacode file.

Toroidal and poloidal flux

We can start from the general forms of the toroidal and poloidal fluxes [DHCS91]

$$\begin{array}{rl}{\mathrm{\Psi }}_t\doteq & \underset{S_t}{\iint }\mathbf{B}\cdot d\mathbf{S}=\frac{1}{2\pi }\underset{V_t}{\iiint }\mathbf{B}\cdot \mathrm{\nabla }\phi dV,\\ {\mathrm{\Psi }}_p\doteq & \underset{S_p}{\iint }\mathbf{B}\cdot d\mathbf{S}=\frac{1}{2\pi }\underset{V_p}{\iiint }\mathbf{B}\cdot \mathrm{\nabla }\theta dV.\end{array}$$

Explicitly inserting the field-aligned coordinate system of the previous section, and differentiating these with respect to $\psi$, gives

$$\begin{array}{rl}\frac{d{\mathrm{\Psi }}_t}{d\psi }=& \frac{1}{2\pi }{\int }_0^{2\pi }d\phi {\int }_0^{2\pi }d\theta \mathbf{B}\cdot \mathrm{\nabla }\phi {\mathcal{J}}_{\psi },\\ =& \frac{1}{2\pi }{\int }_0^{2\pi }d\phi {\int }_0^{2\pi }d\theta \frac{\mathbf{B}\cdot \mathrm{\nabla }\phi }{\mathbf{B}\cdot \mathrm{\nabla }\theta },\\ =& 2\pi q(\psi ),\end{array}$$

$$\begin{array}{rl}\frac{d{\mathrm{\Psi }}_p}{d\psi }=& \frac{1}{2\pi }{\int }_0^{2\pi }d\phi {\int }_0^{2\pi }d\theta \mathbf{B}\cdot \mathrm{\nabla }\theta {\mathcal{J}}_{\psi },\\ =& \frac{1}{2\pi }{\int }_0^{2\pi }d\phi {\int }_0^{2\pi }d\theta ,\\ =& 2\pi .\end{array}$$

Thus, $\psi$ is the poloidal flux divided by $2\pi$. For this reason, it is useful to also define the toroidal flux divided by $2\pi$:

$${\chi }_t\doteq \frac{1}{2\pi }{\mathrm{\Psi }}_t.$$

According to these conventions,

$$d{\mathrm{\Psi }}_t=qd{\mathrm{\Psi }}_p\text{and}d{\chi }_t=qd\psi .$$