Add changelog, and add default formulation for all eigensolve fns

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change log
+
+## Unreleased
+- Set `Formulation.JONES_DIRECT_FOURIER` as the default formulation for all eigensolve functions in `fmm` module.
+
+## 0.14.4 (February 25, 2025)
+- Set `Formulation.JONES_DIRECT_FOURIER` as the default formulation for `fmm.eigensolve_isotropic_media`.
+- Set `Truncation.CIRCULAR` as the default truncation for `basis.generate_expansion`.
+- Expand documentation for `fmm.Formulation` enum, describing each formulation.
+
+## 0.13.4 (January 30, 2025)
+- Add a `fields.time_average_z_poynting_flux` function to compute the real-space z-oriented Poynting flux from the real-space electromagnetic fields.
+
+## 0.13.3 (January 25, 2025)
+- Avoid post-init validation for `fmm.LayerSolveResult` when the attributes are not arrays, e.g. tracer objects. This allows the `LayerSolveResult` to be returned by a jit-ed function.
+
+## 0.13.2 (January 24, 2025)
+- Adjust shapes of transverse and z permeability matrices for uniform isotropic media to ensure they have shapes matching those obtained when performing a patterned layer eigensolve. This allows solve reuslts to be concatenated.
+
+## 0.13.1 (January 15, 2025)
+- Relax minimum jax dependency to `>= 0.4.27`. There is a bug in some newer jax versions which causes hanging with the CPU backend (https://github.com/jax-ml/jax/issues/24219).
+
+## 0.13.0 (January 14, 2025)
+- Reorganize the project to make the `_fmm_matrices` and `_fft` modules are made private.
+- Update the build CI workflow to test older, known-good jax versions.

src/fmmax/fmm.py

@@ -76,13 +76,16 @@ class Formulation(enum.Enum):
     POL_FOURIER = vector.POL_FOURIER
 
 
+_DEFAULT_FORMULATION = Formulation.JONES_DIRECT_FOURIER
+
+
 def eigensolve_isotropic_media(
     wavelength: jnp.ndarray,
     in_plane_wavevector: jnp.ndarray,
     primitive_lattice_vectors: basis.LatticeVectors,
     permittivity: jnp.ndarray,
     expansion: basis.Expansion,
-    formulation: Formulation | VectorFn = Formulation.JONES_DIRECT_FOURIER,
+    formulation: Formulation | VectorFn = _DEFAULT_FORMULATION,
 ) -> "LayerSolveResult":
     """Performs the eigensolve for a layer with isotropic permittivity.
 
@@ -130,7 +133,7 @@ def eigensolve_anisotropic_media(
     permittivity_yy: jnp.ndarray,
     permittivity_zz: jnp.ndarray,
     expansion: basis.Expansion,
-    formulation: Formulation | VectorFn,
+    formulation: Formulation | VectorFn = _DEFAULT_FORMULATION,
 ) -> "LayerSolveResult":
     """Performs the eigensolve for a layer with anisotropic permittivity.
 
@@ -191,7 +194,7 @@ def eigensolve_general_anisotropic_media(
     permeability_yy: jnp.ndarray,
     permeability_zz: jnp.ndarray,
     expansion: basis.Expansion,
-    formulation: Formulation | VectorFn,
+    formulation: Formulation | VectorFn = _DEFAULT_FORMULATION,
     vector_field_source: Optional[jnp.ndarray] = None,
 ) -> "LayerSolveResult":
     """Performs the eigensolve for a general anistropic layer.