Background fields

Equilibria

Explore the reference equilibria used to initialize Struphy simulations. Each slice is generated from the corresponding Struphy equilibrium class during the site build.

Equilibrium

AdhocTorus

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	1	Minor radius of torus (default: 1.).
`R0`	3	Major radius of torus (default: 3.).
`B0`	2	On-axis (r=0) toroidal magnetic field (default: 2.).
`q_kind`	0	Which safety factor profile, see docstring (0 or 1, default: 0).
`q0`	1.71	Safety factor at r=0 (default: 1.71).
`q1`	1.87	Safety factor at r=a (default: 1.87).
`n1`	2	1st shape factor for ion number density profile (default: 0.).
`n2`	1	2nd shape factor for ion number density profile (default: 0.).
`na`	0.2	Ion number density at r=a (default: 1.).
`p_kind`	1	Kind of pressure profile, see docstring (0 or 1, default: 1).
`p0`	1	constant factor for ad hoc pressure profile (default: 1.).
`p1`	0.1	1st shape factor for ad hoc pressure profile (default: 0.).
`p2`	0.1	2nd shape factor for ad hoc pressure profile (default: 0.).
`beta`	0.179	On-axis (r=0) plasma beta if p_kind=1 (ratio of kinematic pressure to B^2/(2*mu0), default: 0.179).
`psi_k`	3	Spline degree to be used for interpolation of poloidal flux function (if q_kind=1, default=3).
`psi_nel`	50	Number of cells to be used for interpolation of poloidal flux function (if q_kind=1, default=50).

Equilibrium

AdhocTorusQPsi

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	0.361925	Minor radius of torus (default: 0.361925).
`R0`	1	Major radius of torus (default: 1.).
`B0`	1	On-axis (r=0) toroidal magnetic field (default: 1.).
`q0`	0.35	Safety factor at r=0 (default: 0.6).
`q1`	5	Safety factor at r=a (default: 2.5).
`q0p`	0.78	Derivative of safety factor at r=0 (w.r.t. poloidal flux function, default: 0.78).
`q1p`	5	Derivative of safety factor at r=a (w.r.t. poloidal flux function, default: 5.00).
`n1`	2	1st shape factor for ion number density profile (default: 0.).
`n2`	1	2nd shape factor for ion number density profile (default: 0.).
`na`	0.2	Ion number density at r=a (default: 1.).
`beta`	6	On-axis (r=0) plasma beta (ratio of kinematic pressure to B^2/(2*mu0), default: 0.1).
`p1`	0.25	Shape factor for pressure profile, see docstring (default: 0.25).
`psi_k`	3	Spline degree to be used for interpolation of poloidal flux function (default=3).
`psi_nel`	50	Number of cells to be used for interpolation of poloidal flux function (default=50).

Equilibrium

CircularTokamak

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	1	Minor radius of torus (default: 1.).
`R0`	2	Major radius of torus (default: 2.).
`B0`	4	On-axis (r=0) toroidal magnetic field (default: 10.).
`Bp`	60	Poloidal magnetic field (default: 12.5).

Equilibrium

ConstantVelocity

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`ux`	0	—
`uy`	0	—
`uz`	0	—
`velocity_step_function_in_y`	null	If provided, x-velocity is applied only for ``y < value``.
`n`	1	Base number density.
`n1`	0	Linear coefficient used when ``density_profile == 'affine'``.
`density_profile`	gaussian_xy	One of ``'constant'``, ``'affine'``, ``'gaussian_xy'``, or ``'step_function_xy'``. upper_x, lower_x, upper_y, lower_y : float or None Bounds used by the ``'step_function_xy'`` profile (optional).
`upper_x`	null	—
`lower_x`	null	—
`upper_y`	null	—
`lower_y`	null	—
`p0`	0.35	Reference pressure (also used as the Gaussian width parameter).

Equilibrium

CurrentSheet

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`delta`	0.08
`amp`	8

Equilibrium

EQDSKequilibrium

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`rel_path`	true	Whether file is relative to "<struphy_path>/fields_background/mhd_equil/eqdsk/data/", or is an absolute path (default: True).
`file`	null	Path to eqdsk file (default: "AUGNLED_g031213.00830.high").
`data_type`	0	0: there is no space between data, 1: there is space between data (default: 0).
`degree_for_psi`	[3,3]	Spline degrees in (R, Z) directions used for interpolation of psi data (default: [3, 3]).
`psi_resolution`	[25,6.25]	Resolution of psi data in (R, Z) directions in %, e.g. [50., 50.] uses every second psi data point (default: [25., 6.25]).
`degree_for_flux`	3	Spline degree in psi direction used for interpolation of 1d functions that depend on psi: f=f(psi) (default: 3).
`flux_resolution`	50	Resolution of 1d f=f(psi) data in %, e.g. 25. uses every forth data point (default: 50.).
`n1`	2	1st shape factor for ion number density profile n = n(psi) (default: 0.).
`n2`	1	2nd shape factor for ion number density profile n = n(psi) (default: 0.).
`na`	0.2	Ion number density at plasma boundary (default: 1.).
`base_units`	null	Struphy base units. If None, no rescaling of output is performed.

Equilibrium

GenericCartesianFluidEquilibrium

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`u_xyz`	null	—
`p_xyz`	<function available_equilibria.<locals>.<lambda> at 0x7f72a3eb7e20>	—
`n_xyz`	<function available_equilibria.<locals>.<lambda> at 0x7f72a3eb7ec0>	—

Equilibrium

GenericCartesianFluidEquilibriumWithB

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`u_xyz`	null	—
`p_xyz`	<function available_equilibria.<locals>.<lambda> at 0x7f72a3f0c040>	—
`n_xyz`	<function available_equilibria.<locals>.<lambda> at 0x7f72a3f0c0e0>	—

Equilibrium

HomogenSlab

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`B0x`	1.2	x-component of magnetic field (default: 0.).
`B0y`	0.8	y-component of magnetic field (default: 0.).
`B0z`	1	z-component of magnetic field (default: 1.).
`beta`	2	Plasma beta (ratio of kinematic pressure to B^2/(2*mu0), default: 0.1).
`n0`	1	Ion number density (default: 1.).

Equilibrium

HomogenSlabITG

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`B0z`	1	z-component of magnetic field (default: 1.).
`Lx`	6	Domain length in x; 1/Lx is the temperature scale length.
`p0`	1	Constant pressure coefficient (default: 1.).
`pmin`	0.1	Minimum pressure at x = Lx.
`n0`	1	Ion number density (default: 1.).
`eps`	0.1	The unit factor :math:`1/(\hat\Omega_i \hat t)`.

Equilibrium

ScrewPinch

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	1	"Minor" radius (radius of cylinder, default: 1.).
`R0`	3	"Major" radius (must be compatible with :math:`L_z=2\pi R_0`, default: 5.).
`B0`	1	z-component of magnetic field (constant) (default: 1.).
`q0`	1.05	Safety factor at r=0 (use the string "inf" for infinity, default: 1.05).
`q1`	1.8	Safety factor at r=a (use the string "inf" for infinity, default: 1.80).
`n1`	2	1st shape factor for ion number density profile (default: 0.).
`n2`	2	2nd shape factor for ion number density profile (default: 0.).
`na`	0.25	Ion nnumber density at r=a (default: 1.).
`p0`	1e-8	Pressure offset to avoid numerical issues (default: 1e-8)
`beta`	0.1	Plasma beta for :math:`q_0=q_1=\infty` (ratio of kinematic pressure to B^2/2, default: 0.1).

Equilibrium

ShearedSlab

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	1
`R0`	3
`B0`	1
`q0`	1.05
`q1`	1.8
`n1`	2
`n2`	2
`na`	0.25
`beta`	0.1
`q_kind`	0

Equilibrium

ShearFluid

Pressure p

Density n

Coordinates: x–y · value 0

Pressure p

Density n

Coordinates: x–z · value 0

Pressure p

Density n

Coordinates: y–z · value 0

Coordinate-line profiles

Each line varies one coordinate while the other two remain zero.

X-line (other coordinates = 0)

Pressure pDensity n

Y-line (other coordinates = 0)

Pressure pDensity n

Z-line (other coordinates = 0)

Pressure pDensity n

Parameters

Parameter	Value	Description
`a`	1
`b`	1
`c`	1
`z1`	0.25
`z2`	0.75
`delta`	0.06666666
`na`	1
`nb`	0.25
`pa`	1
`pb`	0
`B0x`	1
`B0y`	0
`B0z`	0