feat: Adds methods for obtaining the full dipole from simpler model description.

pdme/model/__init__.py

@@ -1,5 +1,7 @@
 from pdme.model.model import Model, Discretisation
 from pdme.model.fixed_z_plane_model import FixedZPlaneModel
 from pdme.model.unrestricted_model import UnrestrictedModel
+from pdme.model.fixed_dipole_model import FixedDipoleModel
+from pdme.model.fixed_magnitude_model import FixedMagnitudeModel
 
-__all__ = ["Model", "Discretisation", "FixedZPlaneModel", "UnrestrictedModel"]
+__all__ = ["Model", "Discretisation", "FixedZPlaneModel", "UnrestrictedModel", "FixedDipoleModel", "FixedMagnitudeModel"]

pdme/model/fixed_dipole_model.py

@@ -37,6 +37,12 @@ class FixedDipoleModel(Model):
 		s_pts = numpy.array((self.rng.uniform(self.xmin, self.xmax), self.rng.uniform(self.ymin, self.ymax), self.rng.uniform(self.zmin, self.zmax)))
 		return OscillatingDipoleArrangement([OscillatingDipole(self.p, s_pts, frequency)])
 
+	def solution_single_dipole(self, pt: numpy.ndarray) -> OscillatingDipole:
+		# assume length is 4.
+		s = pt[0:3]
+		w = pt[3]
+		return OscillatingDipole(self.p, s, w)
+
 	def point_length(self) -> int:
 		'''
 			Dipole is constrained magnitude, but free orientation.

pdme/model/fixed_magnitude_model.py

@@ -30,7 +30,21 @@ class FixedMagnitudeModel(Model):
 		self.rng = numpy.random.default_rng()
 
 	def __repr__(self) -> str:
-		return f'FixedMagnitudeModel({self.xmin}, {self.xmax}, {self.ymin}, {self.ymax}, {self.zmin}, {self.zmax}, {self.n()})'
+		return f'FixedMagnitudeModel({self.xmin}, {self.xmax}, {self.ymin}, {self.ymax}, {self.zmin}, {self.zmax}, {self.pfixed}, {self.n()})'
+
+	def solution_single_dipole(self, pt: numpy.ndarray) -> OscillatingDipole:
+		# assume length is 6, who needs error checking.
+		p_theta = pt[0]
+		p_phi = pt[1]
+		s = pt[2:5]
+		w = pt[5]
+
+		p = numpy.array([
+			self.pfixed * numpy.sin(p_theta) * numpy.cos(p_phi),
+			self.pfixed * numpy.sin(p_theta) * numpy.sin(p_phi),
+			self.pfixed * numpy.cos(p_theta)
+		])
+		return OscillatingDipole(p, s, w)
 
 	def point_length(self) -> int:
 		'''

pdme/model/model.py

@@ -1,7 +1,7 @@
 import numpy
 import scipy.optimize
-from typing import Callable, Sequence, Tuple
-from pdme.measurement import DotMeasurement, OscillatingDipoleArrangement
+from typing import Callable, Sequence, Tuple, List
+from pdme.measurement import DotMeasurement, OscillatingDipoleArrangement, OscillatingDipole
 import pdme.util
 import logging
 
@@ -26,6 +26,14 @@ class Model():
 	def get_dipoles(self, frequency: float) -> OscillatingDipoleArrangement:
 		raise NotImplementedError
 
+	def solution_single_dipole(self, pt: numpy.ndarray) -> OscillatingDipole:
+		raise NotImplementedError
+
+	def solution_as_dipoles(self, pts: numpy.ndarray) -> List[OscillatingDipole]:
+		pt_length = self.point_length()
+		chunked_pts = [pts[i: i + pt_length] for i in range(0, len(pts), pt_length)]
+		return [self.solution_single_dipole(pt) for pt in chunked_pts]
+
 	def cost_for_dot(self, dot: DotMeasurement, pts: numpy.ndarray) -> float:
 		# creates numpy.ndarrays in groups of self.point_length().
 		# Will throw problems for irregular points, but that's okay for now.