desc.grid.Grid
- class desc.grid.Grid(nodes, sort=False, jitable=False)Source
Collocation grid with custom node placement.
Unlike subclasses LinearGrid and ConcentricGrid, the base Grid allows the user to pass in a custom set of collocation nodes.
- Parameters:
nodes (ndarray of float, size(num_nodes,3)) – Node coordinates, in (rho,theta,zeta)
sort (bool) – Whether to sort the nodes for use with FFT method.
jitable (bool) – Whether to skip certain checks and conditionals that don’t work under jit. Allows grid to be created on the fly with custom nodes, but weights, symmetry etc may be wrong if grid contains duplicate nodes.
Methods
compress
(x[, surface_label])Return elements of
x
at indices of unique surface label values.copy
([deepcopy])Return a (deep)copy of this object.
equiv
(other)Compare equivalence between DESC objects.
expand
(x[, surface_label])Expand
x
by duplicating elements to match the grid's pattern.load
(load_from[, file_format])Initialize from file.
replace_at_axis
(x, y[, copy])Replace elements of
x
with elements ofy
at the axis of grid.save
(file_name[, file_format, file_mode])Save the object.
Attributes
Radial grid resolution.
Poloidal grid resolution.
Toroidal grid resolution.
Number of (toroidal) field periods.
Indices of nodes at magnetic axis.
Indices of unique_rho_idx that recover the rho coordinates.
Indices of unique_theta_idx that recover the theta coordinates.
Indices of unique_zeta_idx that recover the zeta coordinates.
Pattern for placement of nodes in (rho,theta,zeta).
Node coordinates, in (rho,theta,zeta).
Total number of nodes.
Number of unique rho coordinates.
Number of unique theta coordinates.
Number of unique zeta coordinates.
Node spacing, in (rho,theta,zeta).
True for stellarator symmetry, False otherwise.
Indices of unique rho coordinates.
Indices of unique theta coordinates.
Indices of unique zeta coordinates.
Weight for each node, either exact quadrature or volume based.