latest
Theory
General
Zernike Indexing
Getting Started
Installation
On Your Local Machine
On PPPL’s Sunfire Cluster
On Princeton’s Adroit Cluster
On Traverse
Command Line Interface
Positional Arguments
Named Arguments
Input File
General Notes
Global Parameters
Spectral Resolution
Continuation Parameters
Solver Tolerances
Solver Methods
Pressure & Rotational Transform Profiles
Magnetic Axis Initial Guess
Fixed-Boundary Surface Shape
VMEC Inputs
Outputs
ASCII
Grid Parameters
Fixed-Boundary Shape
Pressure & Rotational Transform Profiles
Flux Surface Shapes
Boundary Function
\(\lambda\)
Example Output File
HDF5
Examples
Examples
Public API
API Documentation
Backend
Basis
Boundary Conditions
Configuration
Continuation
Equilibrium IO
Grid
Initial Guess
Input Reader
Objective Functions
Perturbations
Plotting
Transform
VMEC
DESC
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
_
__del__() (desc.equilibrium_io.IO method)
__eq__() (desc.basis.Basis method)
(desc.grid.Grid method)
(desc.transform.Transform method)
__init__() (desc.basis.DoubleFourierSeries method)
(desc.basis.FourierZernikeBasis method)
(desc.basis.PowerSeries method)
(desc.configuration.Configuration method)
(desc.equilibrium_io.hdf5IO method)
(desc.equilibrium_io.hdf5Reader method)
(desc.equilibrium_io.hdf5Writer method)
(desc.equilibrium_io.IO method)
(desc.equilibrium_io.PickleIO method)
(desc.equilibrium_io.PickleReader method)
(desc.equilibrium_io.PickleWriter method)
(desc.grid.ConcentricGrid method)
(desc.grid.Grid method)
(desc.grid.LinearGrid method)
(desc.input_reader.InputReader method)
(desc.objective_funs.AccelErrorSpectral method)
(desc.objective_funs.ForceErrorNodes method)
(desc.objective_funs.ObjectiveFunction method)
(desc.plotting.Plot method)
(desc.transform.Transform method)
__name_key__() (desc.plotting.Plot method)
A
AccelErrorSpectral (class in desc.objective_funs)
ansi_to_lm() (in module desc.transform)
args (desc.input_reader.InputReader attribute)
axis (desc.grid.Grid property)
axis_labels (desc.plotting.Plot attribute)
B
Basis (class in desc.basis)
basis (desc.transform.Transform attribute)
(desc.transform.Transform property)
C
callback() (desc.objective_funs.AccelErrorSpectral method)
(desc.objective_funs.ForceErrorNodes method)
(desc.objective_funs.ObjectiveFunction method)
,
[1]
cf_to_dec() (in module desc.grid)
change_resolution() (desc.basis.Basis method)
(desc.basis.DoubleFourierSeries method)
(desc.basis.FourierZernikeBasis method)
(desc.basis.PowerSeries method)
(desc.configuration.Configuration method)
(desc.grid.ConcentricGrid method)
(desc.grid.Grid method)
(desc.grid.LinearGrid method)
(desc.transform.Transform method)
check_type() (desc.equilibrium_io.IO method)
Checkpoint (class in desc.equilibrium_io)
cI (desc.configuration.Configuration property)
cL (desc.configuration.Configuration property)
close() (desc.equilibrium_io.Checkpoint method)
(desc.equilibrium_io.IO method)
compute() (desc.objective_funs.AccelErrorSpectral method)
(desc.objective_funs.ForceErrorNodes method)
(desc.objective_funs.ObjectiveFunction method)
,
[1]
(desc.plotting.Plot method)
compute_accel_error_spectral() (in module desc.objective_funs)
compute_bdry_err() (in module desc.boundary_conditions)
compute_bdry_err_sfl() (in module desc.boundary_conditions)
compute_contravariant_basis() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_coordinate_derivatives() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_coordinates() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_covariant_basis() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_force_error_nodes() (in module desc.objective_funs)
compute_force_error_RddotZddot() (in module desc.objective_funs)
compute_force_error_RphiZ() (in module desc.objective_funs)
compute_force_magnitude() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_jacobian() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_lambda_err() (in module desc.boundary_conditions)
compute_magnetic_field() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_magnetic_field_magnitude() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_plasma_current() (desc.configuration.Configuration method)
(in module desc.configuration)
compute_qs_error_spectral() (in module desc.objective_funs)
ConcentricGrid (class in desc.grid)
conditional_decorator() (in module desc.backend)
Configuration (class in desc.configuration)
cP (desc.configuration.Configuration property)
cR (desc.configuration.Configuration property)
cRb (desc.configuration.Configuration property)
create_nodes() (desc.grid.ConcentricGrid method)
(desc.grid.Grid method)
(desc.grid.LinearGrid method)
cross() (in module desc.backend)
curve_self_intersects() (in module desc.objective_funs)
cZ (desc.configuration.Configuration property)
cZb (desc.configuration.Configuration property)
D
dec_to_cf() (in module desc.grid)
derivatives (desc.transform.Transform attribute)
(desc.transform.Transform property)
derivs (desc.transform.Transform property)
desc.backend
module
desc.basis
module
desc.boundary_conditions
module
desc.configuration
module
desc.continuation
module
desc.equilibrium_io
module
desc.grid
module
desc.init_guess
module
desc.input_reader
module
desc.objective_funs
module
desc.perturbations
module
desc.plotting
module
desc.transform
module
desc.vmec
module
disp() (desc.backend.Timer method)
dot() (in module desc.backend)
DoubleFourierSeries (class in desc.basis)
E
ENDC (desc.backend.TextColors attribute)
equals() (in module desc.backend)
equilibria (desc.configuration.EquilibriaFamily property)
EquilibriaFamily (class in desc.configuration)
Equilibrium (class in desc.configuration)
evaluate() (desc.basis.Basis method)
(desc.basis.DoubleFourierSeries method)
(desc.basis.FourierZernikeBasis method)
(desc.basis.PowerSeries method)
F
factorial() (in module desc.backend)
FAIL (desc.backend.TextColors attribute)
fit() (desc.transform.Transform method)
flatten_list() (in module desc.backend)
ForceErrorNodes (class in desc.objective_funs)
format_ax() (desc.plotting.Plot method)
format_bdry() (in module desc.boundary_conditions)
format_name() (desc.plotting.Plot method)
fourier() (in module desc.basis)
FourierZernikeBasis (class in desc.basis)
fringe_to_lm() (in module desc.transform)
G
get_equil_obj_fun() (desc.objective_funs.ObjectiveFunctionFactory method)
get_grid() (desc.plotting.Plot method)
get_initial_guess_scale_bdry() (in module desc.init_guess)
get_lambda_constraint_matrix() (in module desc.boundary_conditions)
get_modes() (desc.basis.Basis method)
(desc.basis.DoubleFourierSeries method)
(desc.basis.FourierZernikeBasis method)
(desc.basis.PowerSeries method)
get_parser() (in module desc.input_reader)
get_qisym_obj_fun() (in module desc.objective_funs)
get_system_derivatives() (in module desc.perturbations)
Grid (class in desc.grid)
grid (desc.transform.Transform attribute)
(desc.transform.Transform property)
groups() (desc.equilibrium_io.hdf5IO method)
H
hdf5IO (class in desc.equilibrium_io)
hdf5Reader (class in desc.equilibrium_io)
hdf5Writer (class in desc.equilibrium_io)
HEADER (desc.backend.TextColors attribute)
I
I_basis (desc.configuration.Configuration property)
I_transform (desc.objective_funs.ObjectiveFunction attribute)
initial (desc.configuration.Equilibrium property)
input_path (desc.input_reader.InputReader attribute)
InputReader (class in desc.input_reader)
inputs (desc.input_reader.InputReader attribute)
insert() (desc.configuration.EquilibriaFamily method)
IO (class in desc.equilibrium_io)
IOAble (class in desc.equilibrium_io)
is_nested() (in module desc.objective_funs)
isalmostequal() (in module desc.backend)
issorted() (in module desc.backend)
J
jacobi() (in module desc.basis)
jacobi_coeffs() (in module desc.basis)
L
L (desc.basis.Basis property)
(desc.grid.Grid property)
L_basis (desc.configuration.Configuration property)
L_transform (desc.objective_funs.ObjectiveFunction attribute)
LinearGrid (class in desc.grid)
lm_to_ansi() (in module desc.transform)
lm_to_fringe() (in module desc.transform)
M
M (desc.basis.Basis property)
(desc.grid.Grid property)
matrices (desc.transform.Transform attribute)
(desc.transform.Transform property)
modes (desc.basis.Basis property)
module
desc.backend
desc.basis
desc.boundary_conditions
desc.configuration
desc.continuation
desc.equilibrium_io
desc.grid
desc.init_guess
desc.input_reader
desc.objective_funs
desc.perturbations
desc.plotting
desc.transform
desc.vmec
most_rational() (in module desc.grid)
N
N (desc.basis.Basis property)
(desc.grid.Grid property)
name_label() (desc.plotting.Plot method)
NFP (desc.basis.Basis property)
(desc.configuration.Configuration property)
(desc.grid.Grid property)
nodes (desc.grid.Grid property)
num_modes (desc.basis.Basis property)
(desc.transform.Transform property)
num_nodes (desc.grid.Grid property)
(desc.transform.Transform property)
O
objective (desc.configuration.Equilibrium property)
ObjectiveFunction (class in desc.objective_funs)
ObjectiveFunctionFactory (class in desc.objective_funs)
OKBLUE (desc.backend.TextColors attribute)
OKCYAN (desc.backend.TextColors attribute)
open_file() (desc.equilibrium_io.hdf5IO method)
(desc.equilibrium_io.IO method)
(desc.equilibrium_io.PickleIO method)
optimize() (desc.configuration.Equilibrium method)
optimizer (desc.configuration.Equilibrium property)
output_path (desc.input_reader.InputReader attribute)
output_to_file() (in module desc.equilibrium_io)
P
P_basis (desc.configuration.Configuration property)
P_transform (desc.objective_funs.ObjectiveFunction attribute)
parse_args() (desc.input_reader.InputReader method)
,
[1]
parse_inputs() (desc.input_reader.InputReader method)
,
[1]
perturb_continuation_params() (in module desc.perturbations)
PickleIO (class in desc.equilibrium_io)
PickleReader (class in desc.equilibrium_io)
PickleWriter (class in desc.equilibrium_io)
pinv (desc.transform.Transform attribute)
Plot (class in desc.plotting)
plot_1d() (desc.plotting.Plot method)
plot_2d() (desc.plotting.Plot method)
plot_3dsurf() (desc.plotting.Plot method)
plot_coeffs() (in module desc.plotting)
plot_comparison() (in module desc.plotting)
plot_coord_surfaces() (in module desc.plotting)
plot_fb_err() (in module desc.plotting)
plot_IC() (in module desc.plotting)
plot_logo() (in module desc.plotting)
plot_vmec_comparison() (in module desc.plotting)
plot_zernike_basis() (in module desc.plotting)
polyder_vec() (in module desc.basis)
polyval_vec() (in module desc.basis)
power_coeffs() (in module desc.basis)
powers() (in module desc.basis)
PowerSeries (class in desc.basis)
pretty_print() (desc.backend.Timer static method)
print_coeffs() (in module desc.plotting)
Psi (desc.configuration.Configuration property)
put() (in module desc.backend)
R
R1_transform (desc.objective_funs.ObjectiveFunction attribute)
R_basis (desc.configuration.Configuration property)
R_transform (desc.objective_funs.ObjectiveFunction attribute)
Rb_basis (desc.configuration.Configuration property)
rcond (desc.transform.Transform attribute)
read_desc() (in module desc.equilibrium_io)
read_dict() (desc.equilibrium_io.hdf5Reader method)
(desc.equilibrium_io.PickleReader method)
(desc.equilibrium_io.Reader method)
read_list() (desc.equilibrium_io.hdf5Reader method)
read_obj() (desc.equilibrium_io.hdf5Reader method)
(desc.equilibrium_io.PickleReader method)
(desc.equilibrium_io.Reader method)
read_vmec_output() (in module desc.vmec)
Reader (class in desc.equilibrium_io)
reader_factory() (in module desc.equilibrium_io)
resolve_base() (desc.equilibrium_io.IO method)
resolve_where() (desc.equilibrium_io.IO method)
rms() (in module desc.backend)
S
save() (desc.configuration.EquilibriaFamily method)
(desc.equilibrium_io.IOAble method)
scalar (desc.objective_funs.ObjectiveFunction attribute)
sfl_err() (in module desc.vmec)
sign() (in module desc.backend)
solve_eq_continuation() (in module desc.continuation)
solved (desc.configuration.Equilibrium property)
solver (desc.configuration.EquilibriaFamily property)
start() (desc.backend.Timer method)
stop() (desc.backend.Timer method)
sub() (desc.equilibrium_io.hdf5IO method)
sym (desc.basis.Basis property)
(desc.configuration.Configuration property)
(desc.grid.Grid property)
T
TextColors (class in desc.backend)
Timer (class in desc.backend)
TIMER (desc.backend.TextColors attribute)
Transform (class in desc.transform)
transform() (desc.transform.Transform method)
Tristate (class in desc.backend)
U
unpack_state() (in module desc.configuration)
V
vmec_error() (in module desc.vmec)
vmec_interpolate() (in module desc.vmec)
vmec_to_desc_input() (in module desc.equilibrium_io)
vmec_transf() (in module desc.vmec)
volumes (desc.grid.Grid property)
W
WARNING (desc.backend.TextColors attribute)
write_desc_h5() (in module desc.equilibrium_io)
write_desc_input() (desc.input_reader.InputReader method)
,
[1]
write_dict() (desc.equilibrium_io.hdf5Writer method)
(desc.equilibrium_io.PickleWriter method)
(desc.equilibrium_io.Writer method)
write_hdf5() (in module desc.equilibrium_io)
write_iteration() (desc.equilibrium_io.Checkpoint method)
write_list() (desc.equilibrium_io.hdf5Writer method)
write_obj() (desc.equilibrium_io.hdf5Writer method)
(desc.equilibrium_io.PickleWriter method)
(desc.equilibrium_io.Writer method)
Writer (class in desc.equilibrium_io)
writer_factory() (in module desc.equilibrium_io)
X
x (desc.configuration.Configuration property)
(desc.configuration.Equilibrium property)
Z
Z1_transform (desc.objective_funs.ObjectiveFunction attribute)
Z_basis (desc.configuration.Configuration property)
Z_transform (desc.objective_funs.ObjectiveFunction attribute)
Zb_basis (desc.configuration.Configuration property)
zernike_norm() (in module desc.transform)