List of Variables ################# The table below contains a list of variables that are used in the code and that are available for plotting / analysis. * **Name** : Name of the variable as it appears in the code. Pass a string with this name to any of the plotting functions to plot, or to the relevant ``.compute()`` method to return the calculated quantity. * **Label** : TeX label for the variable. * **Units** : Physical units for the variable. * **Description** : Description of the variable. * **Aliases** : Alternative names of the variable that are equivalent to the primary name. * **kwargs** : Optional keyword arguments that can be supplied when computing the variable. See the bottom of this page for detailed descriptions and default values of each argument. The only keyword argument that is valid for all variables is 'basis' (see explanation below). All vector quantities are computed in toroidal coordinates :math:`(R,\phi,Z)` by default. 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 those of the DESC :math:`\rho, \theta, \zeta` coordinate system. For example, ``|B|_z`` is :math:`(\partial \vert B \vert / \partial\zeta)|_{\rho, \theta}`. desc.equilibrium.equilibrium.Equilibrium ---------------------------------------- .. csv-table:: List of Variables: desc.equilibrium.equilibrium.Equilibrium :file: desc.equilibrium.equilibrium.Equilibrium.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.curve.FourierRZCurve ---------------------------------- .. csv-table:: List of Variables: desc.geometry.curve.FourierRZCurve :file: desc.geometry.curve.FourierRZCurve.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.curve.FourierXYZCurve ----------------------------------- .. csv-table:: List of Variables: desc.geometry.curve.FourierXYZCurve :file: desc.geometry.curve.FourierXYZCurve.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.curve.FourierPlanarCurve -------------------------------------- .. csv-table:: List of Variables: desc.geometry.curve.FourierPlanarCurve :file: desc.geometry.curve.FourierPlanarCurve.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.curve.SplineXYZCurve ---------------------------------- .. csv-table:: List of Variables: desc.geometry.curve.SplineXYZCurve :file: desc.geometry.curve.SplineXYZCurve.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.surface.FourierRZToroidalSurface ---------------------------------------------- .. csv-table:: List of Variables: desc.geometry.surface.FourierRZToroidalSurface :file: desc.geometry.surface.FourierRZToroidalSurface.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.geometry.surface.ZernikeRZToroidalSection ---------------------------------------------- .. csv-table:: List of Variables: desc.geometry.surface.ZernikeRZToroidalSection :file: desc.geometry.surface.ZernikeRZToroidalSection.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.coils.FourierRZCoil ------------------------ .. csv-table:: List of Variables: desc.coils.FourierRZCoil :file: desc.coils.FourierRZCoil.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.coils.FourierXYZCoil ------------------------- .. csv-table:: List of Variables: desc.coils.FourierXYZCoil :file: desc.coils.FourierXYZCoil.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.coils.FourierPlanarCoil ---------------------------- .. csv-table:: List of Variables: desc.coils.FourierPlanarCoil :file: desc.coils.FourierPlanarCoil.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.magnetic_fields._current_potential.CurrentPotentialField ------------------------------------------------------------- .. csv-table:: List of Variables: desc.magnetic_fields._current_potential.CurrentPotentialField :file: desc.magnetic_fields._current_potential.CurrentPotentialField.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.magnetic_fields._current_potential.FourierCurrentPotentialField -------------------------------------------------------------------- .. csv-table:: List of Variables: desc.magnetic_fields._current_potential.FourierCurrentPotentialField :file: desc.magnetic_fields._current_potential.FourierCurrentPotentialField.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.coils.SplineXYZCoil ------------------------ .. csv-table:: List of Variables: desc.coils.SplineXYZCoil :file: desc.coils.SplineXYZCoil.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 desc.magnetic_fields._core.OmnigenousField ------------------------------------------ .. csv-table:: List of Variables: desc.magnetic_fields._core.OmnigenousField :file: desc.magnetic_fields._core.OmnigenousField.csv :widths: 23, 15, 15, 60, 15, 15 :header-rows: 1 Optional Keyword arguments -------------------------- .. list-table:: kwargs :widths: 25 100 :header-rows: 1 * - Name - Description * - ``H_ISS04`` - float: ISS04 confinement enhancement factor. Default 1. * - ``M_booz`` - int: Maximum poloidal mode number for Boozer harmonics. Default 2*eq.M * - ``N_booz`` - int: Maximum toroidal mode number for Boozer harmonics. Default 2*eq.N * - ``basis_in`` - {'rpz', 'xyz'}: Basis for input params vectors, Default 'xyz' * - ``degree`` - int: Degree of polynomial used for fitting current profile. Default grid.num_rho-1 * - ``fuel`` - str: Fusion fuel, assuming a 50/50 mix. One of {'DT'}. Default is 'DT'. * - ``gamma`` - float: Adiabatic index. Default 0 * - ``helicity`` - tuple: Type of quasisymmetry, (M,N). Default (1,0) * - ``iota`` - float: Value of rotational transform on the Omnigenous surface. Default 1.0 * - ``method`` - Interpolation type, Default 'cubic'. See SplineXYZCurve docs for options. * - ``n_gauss`` - int: Number of quadrature points to use for estimating trapped fraction. Default 20. * - ``zeta0`` - array: points of vanishing integrated local shear to scan over. Default 15 points linearly spaced in [-π/2,π/2]