metafold 0.15.dev0__py3-none-any.whl → 0.15.dev2__py3-none-any.whl

metafold/materials.py

@@ -211,6 +211,111 @@ class MaxwellWeichertParams(ParamsBase):
         )
 
 
+@dataclass
+class HyperfoamTerm:
+    """One Ogden term of a hyperfoam material (mpmgpu allows up to 3)."""
+    mu: float
+    alpha: float
+    poisson_ratio: float
+
+    def to_dict(self):
+        # "_element" tells the ups emitter to render this as a <term>.
+        return {
+            "_element": "term",
+            "mu": float(self.mu),
+            "alpha": float(self.alpha),
+            "poisson_ratio": float(self.poisson_ratio),
+        }
+
+
+@dataclass
+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.
+    """
+    terms: List[HyperfoamTerm]
+    terminal_shear_modulus: Optional[float] = None
+    viscoelastic_series: Optional[List[ViscoelasticMode]] = None
+
+    @classmethod
+    def get_type(self):
+        return "hyperfoam"
+
+    def to_dict(self):
+        d = {
+            "terms": [t.to_dict() for t in self.terms],
+        }
+        if self.terminal_shear_modulus is not None:
+            d["terminal_shear_modulus"] = float(self.terminal_shear_modulus)
+        if self.viscoelastic_series:
+            d["viscoelastic_series"] = [m.to_dict() for m in self.viscoelastic_series]
+        return d
+
+    @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(
+            terms=[
+                HyperfoamTerm(
+                    mu=t["mu"], alpha=t["alpha"], poisson_ratio=t["poisson_ratio"])
+                for t in d["terms"]
+            ],
+            terminal_shear_modulus=d.get("terminal_shear_modulus"),
+            viscoelastic_series=(
+                [ViscoelasticMode(**m) for m in series] if series else None),
+        )
+
+
+@dataclass
+class OrthotropicParams(ParamsBase):
+    """Linear-elastic orthotropic (mpmgpu only; no Uintah equivalent)."""
+    E1: float
+    E2: float
+    E3: float
+    nu12: float
+    nu13: float
+    nu23: float
+    G12: float
+    G13: float
+    G23: float
+    direction_a: List[float]
+    direction_b: List[float]
+
+    @classmethod
+    def get_type(self):
+        return "orthotropic"
+
+    def to_dict(self):
+        return {
+            "E1": float(self.E1), "E2": float(self.E2), "E3": float(self.E3),
+            "nu12": float(self.nu12), "nu13": float(self.nu13), "nu23": float(self.nu23),
+            "G12": float(self.G12), "G13": float(self.G13), "G23": float(self.G23),
+            # Numeric lists so simulation_configurator emits them as vectors.
+            "direction_a": [float(x) for x in self.direction_a],
+            "direction_b": [float(x) for x in self.direction_b],
+        }
+
+    @classmethod
+    def from_dict(cls, d: dict) -> "OrthotropicParams":
+        def vec(v):
+            return [float(x) for x in (v.split() if isinstance(v, str) else v)]
+        return cls(
+            E1=d["E1"], E2=d["E2"], E3=d["E3"],
+            nu12=d["nu12"], nu13=d["nu13"], nu23=d["nu23"],
+            G12=d["G12"], G13=d["G13"], G23=d["G23"],
+            direction_a=vec(d["direction_a"]),
+            direction_b=vec(d["direction_b"]),
+        )
+
+
 @dataclass
 class CompNeoHookParams(ParamsBase):
     bulk_modulus: float
@@ -351,10 +456,24 @@ class Material:
             ElasticPlasticParams,
             HypoElasticParams,
             ViscoTransIsoHyperParams,
+            HyperfoamParams,
+            OrthotropicParams,
         ]
         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/simulation/run_experiment.py

@@ -251,6 +251,34 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
     return parts
 
 
+# Constitutive models that only the experimental (mpmgpu GPU) solver supports;
+# Uintah has no equivalent, so they require use_experimental_solver.
+_EXPERIMENTAL_ONLY_MATERIALS = {
+    _materials_module.OrthotropicParams.get_type(),
+    _materials_module.HyperfoamParams.get_type(),
+}
+
+
+def _material_type(material: Material) -> str:
+    return material.constitutive_model.params.get_type()
+
+
+def _validate_experimental_materials(config: dict, parts, varying) -> None:
+    """Reject experimental-only materials unless use_experimental_solver is set."""
+    if config.get("use_experimental_solver", False):
+        return
+    materials = [p.material for p in parts]
+    for v in varying:
+        if isinstance(v, VaryMaterial):
+            materials.extend(v.materials)
+    used = {_material_type(m) for m in materials} & _EXPERIMENTAL_ONLY_MATERIALS
+    if used:
+        names = ", ".join(sorted(used))
+        raise ValueError(
+            f"Material(s) {names} are only supported with the experimental "
+            f"solver. Set use_experimental_solver to true to use them.")
+
+
 def validate_experiment_config(config: dict) -> None:
     """Raise ValueError if a manifest can't produce a runnable experiment.
     Mirrors the checks run_experiment performs so an API can reject bad
@@ -258,7 +286,10 @@ def validate_experiment_config(config: dict) -> None:
     """
     if not config.get("project_name", ""):
         raise ValueError("project_name is required")
-    validate_simulation_parts(_build_parts(config.get("parts", [])))
+    parts = _build_parts(config.get("parts", []))
+    validate_simulation_parts(parts)
+    _validate_experimental_materials(
+        config, parts, _build_varying(config.get("varying", [])))
 
 
 def _build_varying(varying_config: list[dict]) -> list[ExperimentVarying]:
@@ -379,6 +410,8 @@ def run_experiment(
     varying = _build_varying(config.get("varying", []))
     sim_params = _build_simulation_parameters(config.get("simulation", {}))
 
+    _validate_experimental_materials(config, parts, varying)
+
     use_experimental_solver = config.get("use_experimental_solver", False)
 
     sim_kwargs: dict = dict(

{metafold-0.15.dev0.dist-info → metafold-0.15.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.15.dev0
+Version: 0.15.dev2
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D
@@ -38,7 +38,7 @@ Requires-Dist: dotenv>=0.9.9; extra == "simulation"
 Requires-Dist: pandas>=2.3.3; extra == "simulation"
 Requires-Dist: plyfile>=1.1.3; extra == "simulation"
 Requires-Dist: pyyaml>=6.0.3; extra == "simulation"
-Requires-Dist: simulation-configurator==0.2.*; extra == "simulation"
+Requires-Dist: simulation-configurator==0.3.*; extra == "simulation"
 Requires-Dist: tables>=3.11.1; extra == "simulation"
 Dynamic: license-file
 

{metafold-0.15.dev0.dist-info → metafold-0.15.dev2.dist-info}/RECORD

@@ -5,16 +5,16 @@ metafold/auth.py,sha256=O4B5vGUr2UmHbw_1BfWqZn-GWvmf_eFpZEpKGgBGrQQ,1079
 metafold/client.py,sha256=ZFftCr5gbRFkrxgBK7NYspBQEQnNzj2tWCbjPqxg5gw,3714
 metafold/exceptions.py,sha256=dJhBgbryBhJUf20FT3eU1rjQJQ-aDEZ25g-YCn_TwQk,110
 metafold/jobs.py,sha256=y-8LknS9yAO26MEPh73z4rTrXxjZjPff-1qxpIARebM,4642
-metafold/materials.py,sha256=QwCWNvF3iR7WzUKq4Q9T6wIRK4_YW1UNOJ_FiC8AVY0,13564
+metafold/materials.py,sha256=gOvkO9zfnumYtL5Xi_Y-6pTPeT2r97THWx4cK_3Ze3Y,17767
 metafold/projects.py,sha256=uZZOuXe80F53SZ5ZFpxFYhhMnfgd4SpPaFgkKTSZvTo,6384
 metafold/utils.py,sha256=DnsW1Xr9mLpVHBNdPrdxNLLcjxSNMkWVvr7cH7UTAxY,1174
 metafold/workflows.py,sha256=Mhv3n3ChUHw1Vaj3q8HNDbOgljn03AF6WslZfXzexsI,7802
 metafold/simulation/__init__.py,sha256=tUW4PfyWnI6UFvIR__JKUD2FjNTM74fSeKuee7Ewjfo,816
 metafold/simulation/compression_experiment.py,sha256=kLtX6V4vc_v2l-mJqpkE29TWE-fb6fCudOqhxv1Bz9U,18442
 metafold/simulation/compression_simulation.py,sha256=69tJPRIXE2G_buqB50gUH2K6790skzRhDLYmc0GZ8ss,121287
-metafold/simulation/run_experiment.py,sha256=RGaQSNhacJwfRZQYzB_jw2_AINhPNNZXp95qfmwWseY,18665
-metafold-0.15.dev0.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
-metafold-0.15.dev0.dist-info/METADATA,sha256=2ES2fXgEdfah0CMIs3yTktO2PasfSzZ4sDrRM5dDVSo,3495
-metafold-0.15.dev0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-metafold-0.15.dev0.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
-metafold-0.15.dev0.dist-info/RECORD,,
+metafold/simulation/run_experiment.py,sha256=ot507fJJra6qZLv_o1hqFoAtwmyE3iBKfhWRR9eNhD0,19930
+metafold-0.15.dev2.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
+metafold-0.15.dev2.dist-info/METADATA,sha256=WVMmhNM44KI_IgoL6IneTSy9_izLz4uRDOq7QOKP50M,3495
+metafold-0.15.dev2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+metafold-0.15.dev2.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
+metafold-0.15.dev2.dist-info/RECORD,,