desc.magnetic_fields.ScaledMagneticField

class desc.magnetic_fields.ScaledMagneticField(scalar, field)Source

Magnetic field scaled by a scalar value.

ie B_new = scalar * B_old

Parameters:
  • scalar (float, int) – scaling factor for magnetic field

  • field (MagneticField) – base field to be scaled

Methods

compute_Bnormal(surface[, eval_grid, ...])

Compute Bnormal from self on the given surface.

compute_magnetic_field(coords[, params, ...])

Compute magnetic field at a set of points.

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.

save_BNORM_file(surface, fname[, basis_M, ...])

Create BNORM-style .txt file containing Bnormal Fourier coefficients.