mmt_multipole_inversion.susceptibility_modules.cartesian_spherical_harmonics#

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)

dip_r :: N x 3 array OR 1 x 3 array

octupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)

dip_r :: N x 3 array OR 1 x 3 array

mmt_multipole_inversion.susceptibility_modules.cartesian_spherical_harmonics.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)

Inputs

dip_r   :: N x 3 array OR 1 x 3 array
pos_r   :: M x 3 array OR 1 x 3 array
Returns
None

Notes

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.cartesian_spherical_harmonics.quadrupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)#

dip_r :: N x 3 array OR 1 x 3 array pos_r :: M x 3 array OR 1 x 3 array

Returns
None
mmt_multipole_inversion.susceptibility_modules.cartesian_spherical_harmonics.octupole_Bz_sus(dip_r, pos_r, Q, n_col_stride)#

dip_r :: N x 3 array OR 1 x 3 array pos_r :: M x 3 array OR 1 x 3 array

Returns
ndarray

N x 7 array with 7 octupole moments from the traceless 3-tensor