foamlib 0.6.14__tar.gz → 0.6.15__tar.gz

{foamlib-0.6.14 → foamlib-0.6.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.14
+Version: 0.6.15
 Summary: A Python interface for interacting with OpenFOAM
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
 Project-URL: Homepage, https://github.com/gerlero/foamlib
@@ -169,21 +169,20 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
-### 🔁 Run an optimization loop in parallel
+### 🔁 Run an optimization loop on a Slurm-based cluster
 
 ```python
 import os
 from pathlib import Path
-from foamlib import AsyncFoamCase
+from foamlib import AsyncSlurmFoamCase
 from scipy.optimize import differential_evolution
 
-base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
-# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
+base = AsyncSlurmFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
 
 async def cost(x):
     async with base.clone() as clone:
         clone[0]["U"].boundary_field["inlet"].value = [x[0], 0, 0]
-        await clone.run()
+        await clone.run(fallback=True) # Run locally if Slurm is not available
         return abs(clone[-1]["U"].internal_field[0][0])
 
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)

{foamlib-0.6.14 → foamlib-0.6.15}/README.md

@@ -114,21 +114,20 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
-### 🔁 Run an optimization loop in parallel
+### 🔁 Run an optimization loop on a Slurm-based cluster
 
 ```python
 import os
 from pathlib import Path
-from foamlib import AsyncFoamCase
+from foamlib import AsyncSlurmFoamCase
 from scipy.optimize import differential_evolution
 
-base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
-# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
+base = AsyncSlurmFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
 
 async def cost(x):
     async with base.clone() as clone:
         clone[0]["U"].boundary_field["inlet"].value = [x[0], 0, 0]
-        await clone.run()
+        await clone.run(fallback=True) # Run locally if Slurm is not available
         return abs(clone[-1]["U"].internal_field[0][0])
 
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)

{foamlib-0.6.14 → foamlib-0.6.15}/foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.6.14"
+__version__ = "0.6.15"
 
 from ._cases import (
     AsyncFoamCase,

{foamlib-0.6.14 → foamlib-0.6.15}/foamlib/_files/_files.py

@@ -189,6 +189,10 @@ class FoamFile(
         elif not isinstance(keywords, tuple):
             keywords = (keywords,)
 
+        if keywords and not isinstance(normalize(keywords[-1], kind=Kind.KEYWORD), str):
+            msg = f"Invalid keyword: {keywords[-1]}"
+            raise ValueError(msg)
+
         with self:
             try:
                 write_header = (
@@ -293,7 +297,7 @@ class FoamFile(
                     ...,
                     before
                     + indentation
-                    + dumps(keywords[-1])
+                    + dumps(keywords[-1], kind=Kind.KEYWORD)
                     + b"\n"
                     + indentation
                     + b"{\n"
@@ -311,7 +315,7 @@ class FoamFile(
                     normalize(data, kind=kind),
                     before
                     + indentation
-                    + dumps(keywords[-1])
+                    + dumps(keywords[-1], kind=Kind.KEYWORD)
                     + b" "
                     + dumps(data, kind=kind)
                     + b";"

{foamlib-0.6.14 → foamlib-0.6.15}/foamlib/_files/_serialization.py

@@ -26,6 +26,7 @@ except ModuleNotFoundError:
 
 class Kind(Enum):
     DEFAULT = auto()
+    KEYWORD = auto()
     SINGLE_ENTRY = auto()
     ASCII_FIELD = auto()
     DOUBLE_PRECISION_BINARY_FIELD = auto()
@@ -56,11 +57,6 @@ def normalize(
         assert isinstance(ret, list)
         return ret
 
-    if kind == Kind.SINGLE_ENTRY and isinstance(data, tuple):
-        ret = normalize(list(data))
-        assert isinstance(ret, list)
-        return ret
-
     if isinstance(data, Mapping):
         return {k: normalize(v, kind=kind) for k, v in data.items()}
 
@@ -73,22 +69,43 @@ def normalize(
         data = cast(Sequence[float], data)
         return FoamFileBase.DimensionSet(*data)
 
-    if is_sequence(data) and not isinstance(data, tuple):
+    if is_sequence(data) and (kind == Kind.SINGLE_ENTRY or not isinstance(data, tuple)):
         return [normalize(d, kind=Kind.SINGLE_ENTRY) for d in data]
 
     if isinstance(data, str):
+        data = data.strip()
+
+        if data.startswith("(") and data.endswith(")"):
+            data = data[1:-1].split()
+            if kind == Kind.KEYWORD:
+                return "(" + " ".join(data) + ")"
+            return [normalize(d, kind=Kind.SINGLE_ENTRY) for d in data]
+
+        if data.startswith("[") and data.endswith("]"):
+            data = data[1:-1].split()
+            return normalize(data, kind=Kind.DIMENSIONS)
+
         with contextlib.suppress(ValueError):
             return int(data)
 
         with contextlib.suppress(ValueError):
             return float(data)
 
+        if kind != Kind.KEYWORD:
+            if data in ("yes", "true", "on", "y", "t"):
+                return True
+            if data in ("no", "false", "off", "n", "f"):
+                return False
+
         tokens: list[str] = re.findall(_TOKENS, data)
 
         if len(tokens) == 1:
             return tokens[0]
 
-        return tuple(tokens) if kind != Kind.SINGLE_ENTRY else " ".join(tokens)
+        if kind == Kind.KEYWORD:
+            return " ".join(tokens)
+
+        return tuple(tokens)
 
     if isinstance(data, FoamFileBase.Dimensioned):
         value = normalize(data.value, kind=Kind.SINGLE_ENTRY)
@@ -115,12 +132,15 @@ def dumps(
     if isinstance(data, Mapping):
         entries = []
         for k, v in data.items():
-            if isinstance(v, Mapping):
-                entries.append(dumps(k) + b" {" + dumps(v) + b"}")
-            elif not v:
-                entries.append(dumps(k) + b";")
+            value = normalize(v)
+            if isinstance(value, Mapping):
+                entries.append(
+                    dumps(k, kind=Kind.KEYWORD) + b" {" + dumps(value) + b"}"
+                )
+            elif not value:
+                entries.append(dumps(k, kind=Kind.KEYWORD) + b";")
             else:
-                entries.append(dumps(k) + b" " + dumps(v) + b";")
+                entries.append(dumps(k, kind=Kind.KEYWORD) + b" " + dumps(value) + b";")
 
         return b" ".join(entries)
 

{foamlib-0.6.14 → foamlib-0.6.15}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.14
+Version: 0.6.15
 Summary: A Python interface for interacting with OpenFOAM
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
 Project-URL: Homepage, https://github.com/gerlero/foamlib
@@ -169,21 +169,20 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
-### 🔁 Run an optimization loop in parallel
+### 🔁 Run an optimization loop on a Slurm-based cluster
 
 ```python
 import os
 from pathlib import Path
-from foamlib import AsyncFoamCase
+from foamlib import AsyncSlurmFoamCase
 from scipy.optimize import differential_evolution
 
-base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
-# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
+base = AsyncSlurmFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
 
 async def cost(x):
     async with base.clone() as clone:
         clone[0]["U"].boundary_field["inlet"].value = [x[0], 0, 0]
-        await clone.run()
+        await clone.run(fallback=True) # Run locally if Slurm is not available
         return abs(clone[-1]["U"].internal_field[0][0])
 
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)