LarGeometry
dexter.LarGeometry(baxis: float, raxis: float, rlast: float)
¶
Analytical Large Aspect Ratio Geometry of a circular cross section device.
Parameters:
-
baxis(float) –The magnetic field strength on the magnetic axis \(B_0\) in \([T]\).
-
raxis(float) –The horizontal position of the magnetic axis \(R_0\) in \([m]\).
-
rlast(float) –The value of the \(r\) coordinate at the at the last closed flux surface, \(r_{LCFS}\), in \([m]\).
Methods:
-
r_of_psi–The \(r(\psi)\) value in \([m]\).
-
r_of_psip–The \(r(\psi_p)\) value in \([m]\).
-
psi_of_r–The \(\psi(r)\) value in Normalized Units.
-
psip_of_r–The \(\psi_p(r)\) value in Normalized Units.
-
plot_r_of_psi–Plots \(r(\psi)\), where \(r\) is in \([m]\).
-
plot_r_of_psip–Plots \(r(\psi_p)\), where \(r\) is in \([m]\).
-
plot_psi_of_r–Plots \(\psi(r)\), where \(r\) is in \([m]\).
-
plot_psip_of_r–Plots \(\psi_p(r)\), where \(r\) is in \([m]\).
-
plot_last–Plots the device's Last Closed Flux Surface (LCFS) in the \(R, Z\) frame.
-
rlab_of_psi–The \(R_{lab}(\psi, \theta)\) value in \([m]\).
-
rlab_of_psip–The \(R_{lab}(\psi_p, \theta)\) value in \([m]\).
-
zlab_of_psi–The \(Z_{lab}(\psi, \theta)\) value in \([m]\).
-
zlab_of_psip–The \(Z_{lab}(\psi_p, \theta)\) value in \([m]\).
-
jacobian_of_psi–The \(J(\psi, \theta)\) value in \([m]\).
-
jacobian_of_psip–The \(J(\psi_p, \theta)\) value in \([m]\).
Attributes:
-
psi_state(FluxState) –The state of the toroidal flux coordinate.
-
psip_state(FluxState) –The state of the poloidal flux coordinate.
-
equilibrium_type(EquilibriumType) –The object's equilibrium's type.
-
baxis(float) –The magnetic field strength on the magnetic axis \(B_0\) in \([T]\).
-
raxis(float) –The horizontal position of the magnetic axis \(R_0\) in \([m]\).
-
zaxis(float) –The vertical position of the magnetic axis in \([m]\).
-
rgeo(float) –The geometrical axis (device major radius) in \([m]\).
-
rlast(float) –The value of the \(r\) coordinate at the last closed flux surfarce \(r_{LCFS}\), in \([m]\).
-
psi_last(float) –The value of the last closed toroidal flux surface \(\psi_{LCFS}\) in Normalized Units.
-
rlab_last(Array1) –the last \(R_{lab}\) values that correspond to the device’s last closed flux surface.
-
zlab_last(Array1) –the last \(Z_{lab}\) values that correspond to the device’s last closed flux surface.
dexter.LarGeometry.psi_state: FluxState
property
¶
The state of the toroidal flux coordinate.
dexter.LarGeometry.psip_state: FluxState
property
¶
The state of the poloidal flux coordinate.
dexter.LarGeometry.equilibrium_type: EquilibriumType
property
¶
The object's equilibrium's type.
dexter.LarGeometry.baxis: float
property
¶
The magnetic field strength on the magnetic axis \(B_0\) in \([T]\).
dexter.LarGeometry.raxis: float
property
¶
The horizontal position of the magnetic axis \(R_0\) in \([m]\).
dexter.LarGeometry.zaxis: float
property
¶
The vertical position of the magnetic axis in \([m]\).
dexter.LarGeometry.rgeo: float
property
¶
The geometrical axis (device major radius) in \([m]\).
dexter.LarGeometry.rlast: float
property
¶
The value of the \(r\) coordinate at the last closed flux surfarce \(r_{LCFS}\), in \([m]\).
dexter.LarGeometry.psi_last: float
property
¶
The value of the last closed toroidal flux surface \(\psi_{LCFS}\) in Normalized Units.
dexter.LarGeometry.rlab_last: Array1
property
¶
the last \(R_{lab}\) values that correspond to the device’s last closed flux surface.
dexter.LarGeometry.zlab_last: Array1
property
¶
the last \(Z_{lab}\) values that correspond to the device’s last closed flux surface.
dexter.LarGeometry.r_of_psi(psi: ArrayLike) -> NDArray
¶
The \(r(\psi)\) value in \([m]\).
Parameters:
-
psi(ArrayLike) –The toroidal flux \(\psi\) in Normalized Units.
dexter.LarGeometry.r_of_psip(psip: ArrayLike) -> NDArray
¶
The \(r(\psi_p)\) value in \([m]\).
Parameters:
-
psip(ArrayLike) –The poloidal flux \(\psi_p\) in Normalized Units.
dexter.LarGeometry.psi_of_r(r: ArrayLike) -> NDArray
¶
The \(\psi(r)\) value in Normalized Units.
Parameters:
-
r(ArrayLike) –The radial distance \(r\) in \([m]\).
dexter.LarGeometry.psip_of_r(r: ArrayLike) -> NDArray
¶
The \(\psi_p(r)\) value in Normalized Units.
Parameters:
-
r(ArrayLike) –The radial distance \(r\) in \([m]\).
dexter.LarGeometry.plot_r_of_psi(points: int = 1000, data: bool = False, show: bool = True) -> Canvas
¶
Plots \(r(\psi)\), where \(r\) is in \([m]\).
Parameters:
-
points(int, default:1000) –The number of points in which to evaluate \(r(\psi)\). Defaults to 1000.
-
data(bool, default:False) –Whether or not to plot the data array points (numerical equilibria only). Defaults to False.
-
show(bool, default:True) –Whether or not to call
plt.show(). Defaults to True.
Returns:
-
Canvas–The produced
FigureandAx.
dexter.LarGeometry.plot_r_of_psip(points: int = 1000, data: bool = False, show: bool = True) -> Canvas
¶
Plots \(r(\psi_p)\), where \(r\) is in \([m]\).
Parameters:
-
points(int, default:1000) –The number of points in which to evaluate \(r(\psi_p)\). Defaults to 1000.
-
data(bool, default:False) –Whether or not to plot the data array points (numerical equilibria only). Defaults to False.
-
show(bool, default:True) –Whether or not to call
plt.show(). Defaults to True.
Returns:
-
Canvas–The produced
FigureandAx.
dexter.LarGeometry.plot_psi_of_r(points: int = 1000, data: bool = False, show: bool = True) -> Canvas
¶
Plots \(\psi(r)\), where \(r\) is in \([m]\).
Parameters:
-
points(int, default:1000) –The number of points in which to evaluate \(\psi(r)\). Defaults to 1000.
-
data(bool, default:False) –Whether or not to plot the data array points (numerical equilibria only). Defaults to False.
-
show(bool, default:True) –Whether or not to call
plt.show(). Defaults to True.
Returns:
-
Canvas–The produced
FigureandAx.
dexter.LarGeometry.plot_psip_of_r(points: int = 1000, data: bool = False, show: bool = True) -> Canvas
¶
Plots \(\psi_p(r)\), where \(r\) is in \([m]\).
Parameters:
-
points(int, default:1000) –The number of points in which to evaluate \(\psi_p(r)\). Defaults to 1000.
-
data(bool, default:False) –Whether or not to plot the data array points (numerical equilibria only). Defaults to False.
-
show(bool, default:True) –Whether or not to call
plt.show(). Defaults to True.
Returns:
-
Canvas–The produced
FigureandAx.
dexter.LarGeometry.plot_last(show: bool = True) -> Canvas
¶
Plots the device's Last Closed Flux Surface (LCFS) in the \(R, Z\) frame.
Parameters:
-
show(bool, default:True) –Whether or not to call
plt.show(). Defaults to True.
Returns:
-
Canvas–The produced
FigureandAx.
dexter.LarGeometry.rlab_of_psi(psi: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(R_{lab}(\psi, \theta)\) value in \([m]\).
Parameters:
-
psi(ArrayLike) –The toroidal flux \(\psi\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).
dexter.LarGeometry.rlab_of_psip(psip: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(R_{lab}(\psi_p, \theta)\) value in \([m]\).
Parameters:
-
psip(ArrayLike) –The poloidal flux \(\psi_p\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).
dexter.LarGeometry.zlab_of_psi(psi: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(Z_{lab}(\psi, \theta)\) value in \([m]\).
Parameters:
-
psi(ArrayLike) –The toroidal flux \(\psi\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).
dexter.LarGeometry.zlab_of_psip(psip: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(Z_{lab}(\psi_p, \theta)\) value in \([m]\).
Parameters:
-
psip(ArrayLike) –The poloidal flux \(\psi_p\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).
dexter.LarGeometry.jacobian_of_psi(psi: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(J(\psi, \theta)\) value in \([m]\).
Parameters:
-
psi(ArrayLike) –The toroidal flux \(\psi\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).
dexter.LarGeometry.jacobian_of_psip(psip: ArrayLike, theta: ArrayLike) -> NDArray
¶
The \(J(\psi_p, \theta)\) value in \([m]\).
Parameters:
-
psip(ArrayLike) –The poloidal flux \(\psi_p\) in Normalized Units.
-
theta(ArrayLike) –The \(\theta\) angle in \([rads]\).