mmt_multipole_inversion.susceptibility_modules.maxwell_cartesian_polynomials#

Module Contents#

Functions#

dipole_Bz_sus(dip_r, pos_r, Q, n_col_stride)

This function generates the dipolar Bz susceptibility field contributed

quadrupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)

Parameters

octupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)

Parameters

mmt_multipole_inversion.susceptibility_modules.maxwell_cartesian_polynomials.dipole_Bz_sus(dip_r, pos_r, Q, n_col_stride)#

This function generates the dipolar Bz susceptibility field contributed from magnetic point sources over different positions of a scan grid. The method used here is populating the Q matrix which has size:

(len(pos_r), len(dip_r) * n_col_stride)

Parameters
dip_r

N x 3 array OR 1 x 3 array

pos_r

M x 3 array OR 1 x 3 array

Returns
None

None

Calculate magnetic flux Bz-susceptibility per dipole component generated
by dipoles located in position dip_r (m) at position pos_r (m)
Units of result is T / (A m2)
mmt_multipole_inversion.susceptibility_modules.maxwell_cartesian_polynomials.quadrupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)#
Parameters
dip_r

N x 3 array OR 1 x 3 array

pos_r

M x 3 array OR 1 x 3 array

Returns
None

None

mmt_multipole_inversion.susceptibility_modules.maxwell_cartesian_polynomials.octupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)#
Parameters
dip_r

N x 3 array OR 1 x 3 array

pos_r

M x 3 array OR 1 x 3 array

Returns
None

None