foamlib 0.5.0__tar.gz → 0.5.1__tar.gz

{foamlib-0.5.0 → foamlib-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.5.0
+Version: 0.5.1
 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
@@ -155,6 +155,25 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
+### Run an optimization loop in parallel
+
+```python
+import os
+from pathlib import Path
+from foamlib import AsyncFoamCase
+from scipy.optimize import differential_evolution
+
+base = AsyncFoamCase(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()
+        return abs(clone[-1]["U"].internal_field[0][0])
+
+result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
+```
+
 ## Documentation
 
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

{foamlib-0.5.0 → foamlib-0.5.1}/README.md

@@ -101,6 +101,25 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
+### Run an optimization loop in parallel
+
+```python
+import os
+from pathlib import Path
+from foamlib import AsyncFoamCase
+from scipy.optimize import differential_evolution
+
+base = AsyncFoamCase(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()
+        return abs(clone[-1]["U"].internal_field[0][0])
+
+result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
+```
+
 ## Documentation
 
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

{foamlib-0.5.0 → foamlib-0.5.1}/foamlib/__init__.py

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

{foamlib-0.5.0 → foamlib-0.5.1}/foamlib/_cases/_async.py

@@ -5,16 +5,18 @@ import sys
 import tempfile
 from contextlib import asynccontextmanager
 from pathlib import Path
-from typing import (
-    Callable,
-    Optional,
-    Union,
-)
+from typing import Callable, Optional, TypeVar, Union
 
 if sys.version_info >= (3, 9):
-    from collections.abc import AsyncGenerator, Collection, Sequence
+    from collections.abc import (
+        AsyncGenerator,
+        Awaitable,
+        Collection,
+        Iterable,
+        Sequence,
+    )
 else:
-    from typing import AsyncGenerator, Collection, Sequence
+    from typing import AsyncGenerator, Awaitable, Collection, Iterable, Sequence
 
 if sys.version_info >= (3, 11):
     from typing import Self
@@ -27,6 +29,9 @@ from ._recipes import _FoamCaseRecipes
 from ._subprocess import run_async
 from ._util import awaitableasynccontextmanager
 
+X = TypeVar("X")
+Y = TypeVar("Y")
+
 
 class AsyncFoamCase(_FoamCaseRecipes):
     """
@@ -231,3 +236,10 @@ class AsyncFoamCase(_FoamCaseRecipes):
             await self._rmtree(dst.parent)
         else:
             await self._rmtree(dst)
+
+    @staticmethod
+    def map(coro: Callable[[X], Awaitable[Y]], iterable: Iterable[X]) -> Iterable[Y]:
+        """Run an async function on each element of an iterable concurrently."""
+        return asyncio.get_event_loop().run_until_complete(
+            asyncio.gather(*(coro(arg) for arg in iterable))
+        )

{foamlib-0.5.0 → foamlib-0.5.1}/foamlib/_cases/_sync.py

@@ -36,6 +36,10 @@ class FoamCase(_FoamCaseRecipes):
     :param path: The path to the case directory.
     """
 
+    def __init__(self, path: Union["os.PathLike[str]", str] = Path()):
+        super().__init__(path)
+        self._tmp: Optional[bool] = None
+
     @staticmethod
     def _rmtree(
         path: Union["os.PathLike[str]", str], *, ignore_errors: bool = False
@@ -55,6 +59,10 @@ class FoamCase(_FoamCaseRecipes):
         shutil.copytree(src, dest, symlinks=symlinks, ignore=ignore)
 
     def __enter__(self) -> "FoamCase":
+        if self._tmp is None:
+            raise RuntimeError(
+                "Cannot use a non-copied/cloned case as a context manager"
+            )
         return self
 
     def __exit__(
@@ -63,7 +71,15 @@ class FoamCase(_FoamCaseRecipes):
         exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:
-        self._rmtree(self.path)
+        if self._tmp is not None:
+            if self._tmp:
+                self._rmtree(self.path.parent)
+            else:
+                self._rmtree(self.path)
+        else:
+            raise RuntimeError(
+                "Cannot use a non-copied/cloned case as a context manager"
+            )
 
     def clean(
         self,
@@ -160,11 +176,17 @@ class FoamCase(_FoamCaseRecipes):
         """
         if dst is None:
             dst = Path(tempfile.mkdtemp(), self.name)
+            tmp = True
+        else:
+            tmp = False
 
         for name, args, kwargs in self._copy_cmds(dst):
             getattr(self, name)(*args, **kwargs)
 
-        return type(self)(dst)
+        ret = type(self)(dst)
+        ret._tmp = tmp
+
+        return ret
 
     def clone(self, dst: Optional[Union["os.PathLike[str]", str]] = None) -> "Self":
         """
@@ -176,8 +198,14 @@ class FoamCase(_FoamCaseRecipes):
         """
         if dst is None:
             dst = Path(tempfile.mkdtemp(), self.name)
+            tmp = True
+        else:
+            tmp = False
 
         for name, args, kwargs in self._clone_cmds(dst):
             getattr(self, name)(*args, **kwargs)
 
-        return type(self)(dst)
+        ret = type(self)(dst)
+        ret._tmp = tmp
+
+        return ret

foamlib-0.5.1/foamlib/_cases/_util.py

@@ -0,0 +1,49 @@
+import functools
+import sys
+from types import TracebackType
+from typing import (
+    Any,
+    AsyncContextManager,
+    Callable,
+    Generic,
+    Optional,
+    Type,
+    TypeVar,
+)
+
+if sys.version_info >= (3, 9):
+    from collections.abc import Generator
+else:
+    from typing import Generator
+
+
+R = TypeVar("R")
+
+
+class _AwaitableAsyncContextManager(Generic[R]):
+    def __init__(self, cm: "AsyncContextManager[R]"):
+        self._cm = cm
+
+    def __await__(self) -> Generator[Any, Any, R]:
+        return self._cm.__aenter__().__await__()
+
+    async def __aenter__(self) -> R:
+        return await self._cm.__aenter__()
+
+    async def __aexit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc_val: Optional[BaseException],
+        exc_tb: Optional[TracebackType],
+    ) -> Optional[bool]:
+        return await self._cm.__aexit__(exc_type, exc_val, exc_tb)
+
+
+def awaitableasynccontextmanager(
+    cm: Callable[..., "AsyncContextManager[R]"],
+) -> Callable[..., _AwaitableAsyncContextManager[R]]:
+    @functools.wraps(cm)
+    def f(*args: Any, **kwargs: Any) -> _AwaitableAsyncContextManager[R]:
+        return _AwaitableAsyncContextManager(cm(*args, **kwargs))
+
+    return f

{foamlib-0.5.0 → foamlib-0.5.1}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.5.0
+Version: 0.5.1
 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
@@ -155,6 +155,25 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
 
+### Run an optimization loop in parallel
+
+```python
+import os
+from pathlib import Path
+from foamlib import AsyncFoamCase
+from scipy.optimize import differential_evolution
+
+base = AsyncFoamCase(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()
+        return abs(clone[-1]["U"].internal_field[0][0])
+
+result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
+```
+
 ## Documentation
 
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

foamlib-0.5.0/foamlib/_cases/_util.py

@@ -1,27 +0,0 @@
-from types import TracebackType
-from typing import Any, AsyncContextManager, Callable, Optional, Type
-
-
-class _AwaitableAsyncContextManager:
-    def __init__(self, cm: "AsyncContextManager[Any]"):
-        self._cm = cm
-
-    def __await__(self) -> Any:
-        return self._cm.__aenter__().__await__()
-
-    async def __aenter__(self) -> Any:
-        return await self._cm.__aenter__()
-
-    async def __aexit__(
-        self,
-        exc_type: Optional[Type[BaseException]],
-        exc_val: Optional[BaseException],
-        exc_tb: Optional[TracebackType],
-    ) -> Any:
-        return await self._cm.__aexit__(exc_type, exc_val, exc_tb)
-
-
-def awaitableasynccontextmanager(
-    cm: Callable[..., "AsyncContextManager[Any]"],
-) -> Callable[..., _AwaitableAsyncContextManager]:
-    return lambda *args, **kwargs: _AwaitableAsyncContextManager(cm(*args, **kwargs))