"""Differentiable dipole source object."""
from __future__ import annotations
import jax.numpy as jnp
from magpylib_jax._types import ArrayLike
from magpylib_jax.core.base import BaseSource, MagpylibMissingInput
from magpylib_jax.functional import getB, getH, getJ, getM
[docs]
class Dipole(BaseSource):
"""Magnetic dipole source with optional rigid transform."""
_source_type = "dipole"
def __init__(
self,
moment: ArrayLike | None = None,
position: ArrayLike = (0.0, 0.0, 0.0),
orientation: ArrayLike | None = None,
style=None,
style_label: str | None = None,
**kwargs,
) -> None:
self.moment = moment
super().__init__(
position=position,
orientation=orientation,
style=style,
style_label=style_label,
**kwargs,
)
@property
def volume(self) -> float:
return 0.0
@property
def dipole_moment(self) -> jnp.ndarray:
if self.moment is None:
return jnp.zeros((3,), dtype=jnp.float64)
return jnp.asarray(self.moment, dtype=jnp.float64)
def _require_inputs(self) -> None:
if self.moment is None:
raise MagpylibMissingInput("Input moment of Dipole must be set.")
def getH(
self,
*observers: ArrayLike,
in_out: str = "auto",
squeeze: bool = True,
sumup: bool = False,
output: str = "ndarray",
pixel_agg: str | None = None,
) -> jnp.ndarray:
self._require_inputs()
obs = observers[0] if len(observers) == 1 else list(observers)
return getH(
"dipole",
obs,
moment=self.moment,
position=self.position,
orientation=self.orientation,
in_out=in_out,
squeeze=squeeze,
sumup=sumup,
output=output,
pixel_agg=pixel_agg,
)
def getB(
self,
*observers: ArrayLike,
in_out: str = "auto",
squeeze: bool = True,
sumup: bool = False,
output: str = "ndarray",
pixel_agg: str | None = None,
) -> jnp.ndarray:
self._require_inputs()
obs = observers[0] if len(observers) == 1 else list(observers)
return getB(
"dipole",
obs,
moment=self.moment,
position=self.position,
orientation=self.orientation,
in_out=in_out,
squeeze=squeeze,
sumup=sumup,
output=output,
pixel_agg=pixel_agg,
)
def getJ(
self,
*observers: ArrayLike,
in_out: str = "auto",
squeeze: bool = True,
sumup: bool = False,
) -> jnp.ndarray:
self._require_inputs()
obs = observers[0] if len(observers) == 1 else list(observers)
return getJ(
"dipole",
obs,
moment=self.moment,
position=self.position,
orientation=self.orientation,
in_out=in_out,
squeeze=squeeze,
sumup=sumup,
)
def getM(
self,
*observers: ArrayLike,
in_out: str = "auto",
squeeze: bool = True,
sumup: bool = False,
) -> jnp.ndarray:
self._require_inputs()
obs = observers[0] if len(observers) == 1 else list(observers)
return getM(
"dipole",
obs,
moment=self.moment,
position=self.position,
orientation=self.orientation,
in_out=in_out,
squeeze=squeeze,
sumup=sumup,
)
def copy(self, **kwargs) -> Dipole:
return super().copy(**kwargs)