metafold 0.15.dev1__tar.gz → 0.16.0__tar.gz

{metafold-0.15.dev1 → metafold-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.15.dev1
+Version: 0.16.0
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D

{metafold-0.15.dev1 → metafold-0.16.0}/metafold/materials.py

@@ -232,11 +232,14 @@ class HyperfoamTerm:
 class HyperfoamParams(ParamsBase):
     """Ogden hyperfoam (mpmgpu only; no Uintah equivalent).
 
+    The Ogden hyperfoam model is defined entirely by its terms (bulk_modulus is
+    not used, so it is not part of this material; a legacy "bulk_modulus"/"K" is
+    ignored if present on from_dict).
+
     An optional viscoelastic overlay (Prony series) may be supplied via
     terminal_shear_modulus + viscoelastic_series, matching the MaxwellWeichert
     mode structure. Omit both for a purely elastic hyperfoam.
     """
-    bulk_modulus: float
     terms: List[HyperfoamTerm]
     terminal_shear_modulus: Optional[float] = None
     viscoelastic_series: Optional[List[ViscoelasticMode]] = None
@@ -247,7 +250,6 @@ class HyperfoamParams(ParamsBase):
 
     def to_dict(self):
         d = {
-            "bulk_modulus": float(self.bulk_modulus),
             "terms": [t.to_dict() for t in self.terms],
         }
         if self.terminal_shear_modulus is not None:
@@ -258,9 +260,9 @@ class HyperfoamParams(ParamsBase):
 
     @classmethod
     def from_dict(cls, d: dict) -> "HyperfoamParams":
+        # A legacy bulk_modulus/K is ignored (older scripts may still send it).
         series = d.get("viscoelastic_series")
         return cls(
-            bulk_modulus=d["bulk_modulus"],
             terms=[
                 HyperfoamTerm(
                     mu=t["mu"], alpha=t["alpha"], poisson_ratio=t["poisson_ratio"])
@@ -459,7 +461,19 @@ class Material:
         ]
         PARAMS_CLASSES = {c.get_type(): c for c in params_classes}
         cm = d["constitutive_model"]
-        params = PARAMS_CLASSES[cm["type"]].from_dict(cm["params"])
+        model_type = cm.get("type")
+        if model_type not in PARAMS_CLASSES:
+            # ValueError so API callers reject with a 400, not a 500. An
+            # unknown type usually means a client newer than the server.
+            raise ValueError(
+                f"Unknown constitutive model type {model_type!r}. "
+                f"Known types: {', '.join(sorted(PARAMS_CLASSES))}.")
+        try:
+            params = PARAMS_CLASSES[model_type].from_dict(cm["params"])
+        except KeyError as e:
+            # Missing param -> ValueError (400) rather than an uncaught 500.
+            raise ValueError(
+                f"{model_type} material is missing required param {e}.")
         return cls(
             density=d["density"],
             thermal_conductivity=d["thermal_conductivity"],

{metafold-0.15.dev1 → metafold-0.16.0}/metafold/simulation/compression_simulation.py

@@ -260,6 +260,9 @@ class ExperimentPistonBase:
     force_limit: ForceLimit | None = None
     """Apply condition to jump to zero velocity when the given force is reached."""
 
+    releasable: bool = False
+    """Only constrain contact in normal direction if releasable is True."""
+
 
 @dataclass
 class ExperimentPistonMesh(ExperimentMesh, ExperimentPistonBase):
@@ -1308,6 +1311,10 @@ class CompressionSimulation:
                         "conditionValue": info.part.force_limit.value,
                         "conditionAction": "GoToZeroVelocity",
                     })
+                if isinstance(info.part, ExperimentPistonBase) and info.part.releasable:
+                    kwargs.update({
+                        "normal_only": True,
+                    })
                 rigid_contacts.append(
                     Contact(
                         type=info.part.contact_type,

{metafold-0.15.dev1 → metafold-0.16.0}/metafold/simulation/run_experiment.py

@@ -205,6 +205,8 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
                 kwargs["material"] = _resolve_material(entry["material"])
             if "force_limit" in entry:
                 kwargs["force_limit"] = ForceLimit(**entry["force_limit"])
+            if "releasable" in entry:
+                kwargs["releasable"] = entry["releasable"]
             parts.append(ExperimentPistonCylinder(**kwargs))
 
         elif part_type == "piston_box":

{metafold-0.15.dev1 → metafold-0.16.0}/metafold.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.15.dev1
+Version: 0.16.0
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D

{metafold-0.15.dev1 → metafold-0.16.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metafold"
-version = "0.15.dev1"
+version = "0.16.0"
 authors = [
     {name = "Metafold 3D", email = "info@metafold3d.com"},
 ]

{metafold-0.15.dev1 → metafold-0.16.0}/tests/test_compression_simulation.py

@@ -748,6 +748,20 @@ class TestSimConfig:
             assert contact.find(tag) is not None
             assert contact.find(tag).text == value
 
+    def test_releasable_contact(self, ply_folder, basic_parts, tmp_path):
+        parts = deepcopy(basic_parts)
+        parts[0].releasable = True
+        sim = CompressionSimulation(
+            parts=parts,
+            simulation_name="test_sim",
+            stl_folder_path=str(ply_folder),
+            output_path=str(tmp_path / "out"),
+            client=MagicMock(),
+        )
+        sim.create_sim_config()
+        contact = sim.ups.findall("./MaterialProperties/MPM/contact")[0]
+        contact.find("normal_only").text == "true"
+
 
 class TestStressStrainPerPart:
     """stress-strain runs once per deformable part (not one representative).

{metafold-0.15.dev1 → metafold-0.16.0}/tests/test_materials.py

@@ -292,7 +292,6 @@ class TestHyperfoamParams:
             specific_heat=1.36,
             constitutive_model=ConstitutiveModel(
                 params=HyperfoamParams(
-                    bulk_modulus=1.0e6,
                     terms=[
                         HyperfoamTerm(mu=0.16e6, alpha=8.9, poisson_ratio=0.0),
                         HyperfoamTerm(mu=0.01e6, alpha=-2.0, poisson_ratio=0.0),
@@ -307,10 +306,30 @@ class TestHyperfoamParams:
 
     def test_type_key(self):
         d = ConstitutiveModel(
-            params=HyperfoamParams(bulk_modulus=1.0, terms=[])
+            params=HyperfoamParams(terms=[])
         ).to_dict()
         assert d["type"] == "hyperfoam"
 
+    def test_bulk_modulus_not_emitted(self):
+        # bulk_modulus is not part of the Ogden hyperfoam model.
+        d = self._material().constitutive_model.params.to_dict()
+        assert "bulk_modulus" not in d
+        assert "K" not in d
+
+    def test_legacy_bulk_modulus_ignored_on_from_dict(self):
+        # Older scripts / GH plugins may still send bulk_modulus or K — ignore it.
+        d = {
+            "type": "hyperfoam",
+            "params": {
+                "bulk_modulus": 1.0e6,
+                "K": 2.0e6,
+                "terms": [{"mu": 0.16e6, "alpha": 8.9, "poisson_ratio": 0.0}],
+            },
+        }
+        params = HyperfoamParams.from_dict(d["params"])
+        assert len(params.terms) == 1
+        assert "bulk_modulus" not in params.to_dict()
+
     def test_terms_preserved(self):
         d = self._material().constitutive_model.params.to_dict()
         assert len(d["terms"]) == 2
@@ -331,7 +350,6 @@ class TestHyperfoamParams:
             specific_heat=1.36,
             constitutive_model=ConstitutiveModel(
                 params=HyperfoamParams(
-                    bulk_modulus=1.0e6,
                     terms=[HyperfoamTerm(mu=0.16e6, alpha=8.9, poisson_ratio=0.0)],
                     terminal_shear_modulus=5.0e4,
                     viscoelastic_series=[
@@ -389,3 +407,30 @@ class TestOrthotropicParams:
         d = m.to_dict()
         d["constitutive_model"]["params"]["direction_a"] = "1 0 0"
         assert OrthotropicParams.from_dict(d["constitutive_model"]["params"]).direction_a == [1.0, 0.0, 0.0]
+
+
+class TestMaterialFromDictErrors:
+    # from_dict must raise ValueError (not KeyError) so API callers return 400,
+    # not 500. See lightcycle experiments blueprint.
+    def _material_dict(self, mtype, params):
+        return {
+            "density": 1000.0, "thermal_conductivity": 1.0, "specific_heat": 1500,
+            "constitutive_model": {"type": mtype, "params": params},
+        }
+
+    def test_unknown_type_raises_value_error(self):
+        # A client newer than the server sends a type we don't know.
+        d = self._material_dict("some_future_type", {})
+        with pytest.raises(ValueError, match="Unknown constitutive model type"):
+            Material.from_dict(d)
+
+    def test_missing_param_raises_value_error(self):
+        params = {
+            "E1": 1e9, "E2": 1e9, "E3": 1e9,
+            "nu12": 0.3, "nu13": 0.3, "nu23": 0.3,
+            "G12": 5e8, "G13": 5e8, "G23": 5e8,
+            "direction_a": [1.0, 0.0, 0.0], "direction_b": [0.0, 1.0, 0.0],
+        }
+        del params["E1"]
+        with pytest.raises(ValueError, match="missing required param"):
+            Material.from_dict(self._material_dict("orthotropic", params))