# geoana.em.static.MagnetostaticSphere.potential#

MagnetostaticSphere.potential(xyz, field='all')#

Magnetic potential for a permeable sphere in a uniform magnetostatic field.

Parameters:
xyz(…, 3) numpy.ndarray

Locations to evaluate at in units m.

field{‘all’, ‘total’, ‘primary’, ‘secondary’}
Returns:
Vt, Vp, Vs(…, ) np.ndarray

If field == “all”

V(…, ) np.ndarray

If only requesting a single field.

Examples

Here, we define a sphere with permeability mu_sphere in a uniform magnetostatic field with permeability mu_background and plot the total and secondary magnetic potentials.

```>>> import numpy as np
>>> import matplotlib.pyplot as plt
>>> from matplotlib import patches
>>> from mpl_toolkits.axes_grid1 import make_axes_locatable
>>> from geoana.em.static import MagnetostaticSphere
```

Define the sphere.

```>>> mu_sphere = 10. ** -1
>>> mu_background = 10. ** -3
>>> simulation = MagnetostaticSphere(
>>> )
```

Now we create a set of gridded locations and compute the magnetic potentials.

```>>> X, Y = np.meshgrid(np.linspace(-2*radius, 2*radius, 20), np.linspace(-2*radius, 2*radius, 20))
>>> Z = np.zeros_like(X) + 0.25
>>> xyz = np.stack((X, Y, Z), axis=-1)
>>> vt = simulation.potential(xyz, field='total')
>>> vs = simulation.potential(xyz, field='secondary')
```

Finally, we plot the total and secondary magnetic potentials.

```>>> fig, axs = plt.subplots(1, 2, figsize=(18,12))
>>> titles = ['Total Potential', 'Secondary Potential']
>>> for ax, V, title in zip(axs.flatten(), [vt, vs], titles):
>>>     im = ax.pcolor(X, Y, V, shading='auto')
>>>     divider = make_axes_locatable(ax)
>>>     cax = divider.append_axes("right", size="5%", pad=0.05)
>>>     cb = plt.colorbar(im, cax=cax)
>>>     cb.set_label(label= 'Potential (A)')