desc.magnetic_fields.ScaledMagneticField

class desc.magnetic_fields.ScaledMagneticField(scale, 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.
equiv(other)	Compare equivalence between DESC objects.
load(load_from[, file_format])	Initialize from file.
pack_params(p)	Convert a dictionary of parameters into a single array.
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.
save_mgrid(path, Rmin, Rmax, Zmin, Zmax[, ...])	Save the magnetic field to an mgrid NetCDF file in "raw" format.
unpack_params(x)	Convert a single array of concatenated parameters into a dictionary.

Attributes

dim_x	total number of optimizable parameters.
dimensions	dictionary of integers of sizes of each optimizable parameter.
optimizable_params	string names of parameters that have been declared optimizable.
params_dict	dictionary of arrays of optimizable parameters.
scale	scaling factor for magnetic field.
x_idx	arrays of indices for each parameter in concatenated array.