desc.grid.Grid

class desc.grid.Grid(nodes, sort=True)[source]

Base class for collocation grids.

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.

Methods

copy([deepcopy])

Return a (deep)copy of this object.

eq(other)

Compare equivalence between DESC objects.

load(load_from[, file_format])

Initialize from file.

save(file_name[, file_format, file_mode])

Save the object.

Attributes

L

Radial grid resolution.

M

Poloidal grid resolution.

N

Toroidal grid resolution.

NFP

Number of (toroidal) field periods.

axis

Indices of nodes at magnetic axis.

inverse_rho_idx

Indices of unique_rho_idx that recover the rho coordinates.

inverse_theta_idx

Indices of unique_theta_idx that recover the theta coordinates.

inverse_zeta_idx

Indices of unique_zeta_idx that recover the zeta coordinates.

node_pattern

Pattern for placement of nodes in (rho,theta,zeta).

nodes

Node coordinates, in (rho,theta,zeta).

num_nodes

Total number of nodes.

num_rho

Number of unique rho coordinates.

num_theta

Number of unique theta coordinates.

num_zeta

Number of unique zeta coordinates.

spacing

Node spacing, in (rho,theta,zeta).

sym

True for stellarator symmetry, False otherwise.

unique_rho_idx

Indices of unique rho coordinates.

unique_theta_idx

Indices of unique theta coordinates.

unique_zeta_idx

Indices of unique zeta coordinates.

weights

Weight for each node, either exact quadrature or volume based.