Add serialization for Device and BrandtSolution

loganbvh · Jun 30, 2021 · f37a7e5 · f37a7e5
1 parent cfc8f2b
commit f37a7e5
Show file tree

Hide file tree

Showing 10 changed files with 436 additions and 57 deletions.
diff --git a/docs/api/brandt.rst b/docs/api/brandt.rst
@@ -4,7 +4,7 @@
 
 
 ******
-Brandt
+Solver
 ******
 
 The ``superscreen.brandt`` module contains the actual implementation
@@ -23,6 +23,10 @@ Brandt Solution
 .. autoclass:: superscreen.solution.BrandtSolution
     :members:
 
+.. autofunction:: superscreen.io.save_solutions
+
+.. autofunction:: superscreen.io.load_solutions
+
 Supporting Functions
 --------------------
 

diff --git a/docs/api/device.rst b/docs/api/device.rst
@@ -14,53 +14,60 @@ and ``superscreen.parameters`` are used to set up the inputs to a
 - The geometry and penetration depth of all superconducting films
 - The spatial distribution of the applied magnetic field
 
-Geometry
---------
-
-.. autofunction:: superscreen.geometry.rotate
-
-.. autofunction:: superscreen.geometry.ellipse
-
-.. autofunction:: superscreen.geometry.circle
+Devices
+-------
 
-.. autofunction:: superscreen.geometry.rectangle
+Device
+======
 
-.. autofunction:: superscreen.geometry.square
+.. autoclass:: superscreen.device.Device
+    :members:
 
 Layer
------
+=====
 
 .. autoclass:: superscreen.device.Layer
     :members:
 
 Polygon
--------
+=======
 
 .. autoclass:: superscreen.device.Polygon
     :members:
 
-Device
-------
 
-.. autoclass:: superscreen.device.Device
-    :members:
+Geometry
+--------
+
+.. autofunction:: superscreen.geometry.rotate
+
+.. autofunction:: superscreen.geometry.ellipse
+
+.. autofunction:: superscreen.geometry.circle
+
+.. autofunction:: superscreen.geometry.rectangle
+
+.. autofunction:: superscreen.geometry.square
+
+Parameters
+----------
 
 Parameter
----------
+=========
 
 .. autoclass:: superscreen.parameter.Parameter
     :members:
 
 CompositeParameter
-------------------
+==================
 
 .. autoclass:: superscreen.parameter.CompositeParameter
     :members:
     :show-inheritance:
     :inherited-members:
 
 Constant
---------
+========
 
 .. autoclass:: superscreen.parameter.Constant
     :members:

diff --git a/docs/index.rst b/docs/index.rst
@@ -72,8 +72,8 @@ Better yet, click the badge below to try ``SuperScreen`` interactively online vi
    :caption: API Reference
 
    api/device.rst
-   api/fem.rst
    api/brandt.rst
+   api/fem.rst
    api/visualization.rst
 
 .. toctree::

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
+dill
 jupyter
 matplotlib
 meshpy

diff --git a/setup.py b/setup.py
@@ -23,6 +23,7 @@
 PYTHON_VERSION = ">=3.6"
 
 INSTALL_REQUIRES = [
+    "dill",
     "jupyter",
     "matplotlib",
     "meshpy",

diff --git a/superscreen/__init__.py b/superscreen/__init__.py
@@ -6,9 +6,10 @@
 #     LICENSE file in the root directory of this source tree.
 
 from .brandt import convert_field, solve
-from .solution import BrandtSolution
 from .device import Layer, Polygon, Device
+from .io import save_solutions, load_solutions
 from .parameter import Parameter, Constant
+from .solution import BrandtSolution
 from .visualization import (
     auto_grid,
     grids_to_vecs,

diff --git a/superscreen/brandt.py b/superscreen/brandt.py
@@ -262,13 +262,14 @@ def brandt_layer(
 
     if check_lambda:
         if isinstance(london_lambda, (int, float)) and london_lambda <= d:
+            length_units = device.ureg(device.length_units).units
             logger.warn(
-                f"Layer '{layer}': The film thickness, d = {d:.4f} {device.length_units}"
-                f", is greater than or equal to the London penetration depth "
-                f"({lambda_str} = {london_lambda:.4f} {device.length_units}), resulting "
+                f"Layer '{layer}': The film thickness, d = {d:.4f} {length_units:~P}"
+                f", is greater than or equal to the London penetration depth, resulting "
                 f"in an effective penetration depth {Lambda_str} = {Lambda:.4f} "
-                f"{device.length_units} <= {lambda_str}. The assumption that the current density "
-                f"is nearly constant over the thickness of the film may not be valid. "
+                f"{length_units:~P} <= {lambda_str} = {london_lambda:.4f} {length_units:~P}. "
+                f"The assumption that the current density is nearly constant over the "
+                f"thickness of the film may not be valid. "
             )
 
     film_names = [name for name, film in device.films.items() if film.layer == layer]