foamlib 0.6.1__py3-none-any.whl → 0.6.3__py3-none-any.whl

foamlib/__init__.py

@@ -1,21 +1,23 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.6.1"
+__version__ = "0.6.3"
 
 from ._cases import (
     AsyncFoamCase,
     CalledProcessError,
     FoamCase,
     FoamCaseBase,
+    FoamCaseRunBase,
 )
 from ._files import FoamFieldFile, FoamFile, FoamFileBase
 
 __all__ = [
-    "FoamCase",
     "AsyncFoamCase",
-    "FoamCaseBase",
+    "CalledProcessError",
     "FoamFile",
+    "FoamCase",
+    "FoamCaseRunBase",
     "FoamFieldFile",
+    "FoamCaseBase",
     "FoamFileBase",
-    "CalledProcessError",
 ]

foamlib/_cases/__init__.py

@@ -1,11 +1,13 @@
 from ._async import AsyncFoamCase
 from ._base import FoamCaseBase
+from ._run import FoamCaseRunBase
 from ._subprocess import CalledProcessError
 from ._sync import FoamCase
 
 __all__ = [
-    "FoamCaseBase",
-    "FoamCase",
     "AsyncFoamCase",
+    "FoamCaseBase",
+    "FoamCaseRunBase",
     "CalledProcessError",
+    "FoamCase",
 ]

foamlib/_cases/_async.py

@@ -3,7 +3,7 @@ import multiprocessing
 import os
 import sys
 from contextlib import asynccontextmanager
-from typing import Any, Callable, Optional, TypeVar, Union
+from typing import Any, Callable, Optional, TypeVar, Union, overload
 
 if sys.version_info >= (3, 9):
     from collections.abc import (
@@ -23,6 +23,8 @@ else:
 
 import aioshutil
 
+from .._files import FoamFieldFile
+from ._base import FoamCaseBase
 from ._run import FoamCaseRunBase
 from ._subprocess import run_async
 from ._util import ValuedGenerator, awaitableasynccontextmanager
@@ -42,9 +44,25 @@ class AsyncFoamCase(FoamCaseRunBase):
     :param path: The path to the case directory.
     """
 
+    class TimeDirectory(FoamCaseRunBase.TimeDirectory):
+        @property
+        def _case(self) -> "AsyncFoamCase":
+            return AsyncFoamCase(self.path.parent)
+
+        async def cell_centers(self) -> FoamFieldFile:
+            """Write and return the cell centers."""
+            calls = ValuedGenerator(self._cell_centers_calls())
+
+            for coro in calls:
+                await coro
+
+            return calls.value
+
     max_cpus = multiprocessing.cpu_count()
     """
-    Maximum number of CPUs to use for running `AsyncFoamCase`s concurrently. Defaults to the number of CPUs on the system.
+    Maximum number of CPUs to use for running instances of `AsyncFoamCase` concurrently. 
+    
+    Defaults to the number of CPUs on the system.
     """
 
     _reserved_cpus = 0
@@ -106,6 +124,23 @@ class AsyncFoamCase(FoamCaseRunBase):
         for coro in self._clean_calls(check=check):
             await coro
 
+    @overload
+    def __getitem__(
+        self, index: Union[int, float, str]
+    ) -> "AsyncFoamCase.TimeDirectory": ...
+
+    @overload
+    def __getitem__(self, index: slice) -> Sequence["AsyncFoamCase.TimeDirectory"]: ...
+
+    def __getitem__(
+        self, index: Union[int, slice, float, str]
+    ) -> Union["AsyncFoamCase.TimeDirectory", Sequence["AsyncFoamCase.TimeDirectory"]]:
+        ret = super().__getitem__(index)
+        if isinstance(ret, FoamCaseBase.TimeDirectory):
+            return AsyncFoamCase.TimeDirectory(ret)
+        else:
+            return [AsyncFoamCase.TimeDirectory(r) for r in ret]
+
     async def run(
         self,
         cmd: Optional[Union[Sequence[Union[str, "os.PathLike[str]"]], str]] = None,

foamlib/_cases/_base.py

@@ -40,6 +40,10 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
         def __init__(self, path: Union["os.PathLike[str]", str]):
             self.path = Path(path).absolute()
 
+        @property
+        def _case(self) -> "FoamCaseBase":
+            return FoamCaseBase(self.path.parent)
+
         @property
         def time(self) -> float:
             """The time that corresponds to this directory."""
@@ -58,7 +62,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
 
         def __contains__(self, obj: object) -> bool:
             if isinstance(obj, FoamFieldFile):
-                return obj.path.parent == self.path
+                return obj.path.parent == self.path and obj.path.is_file()
             elif isinstance(obj, str):
                 return (self.path / obj).is_file() or (
                     self.path / f"{obj}.gz"

foamlib/_cases/_run.py

@@ -40,11 +40,34 @@ if sys.version_info >= (3, 11):
 else:
     from typing_extensions import Self
 
+from .._files import FoamFieldFile
 from ._base import FoamCaseBase
 from ._subprocess import DEVNULL, STDOUT
 
 
 class FoamCaseRunBase(FoamCaseBase):
+    class TimeDirectory(FoamCaseBase.TimeDirectory):
+        @abstractmethod
+        def cell_centers(
+            self,
+        ) -> Union[FoamFieldFile, Coroutine[None, None, FoamFieldFile]]:
+            raise NotImplementedError
+
+        @property
+        @abstractmethod
+        def _case(self) -> "FoamCaseRunBase":
+            raise NotImplementedError
+
+        def _cell_centers_calls(self) -> Generator[Any, None, FoamFieldFile]:
+            ret = self["C"]
+
+            if ret not in self:
+                yield self._case.run(
+                    ["postProcess", "-func", "writeCellCentres", "-time", self.name]
+                )
+
+            return ret
+
     def __delitem__(self, key: Union[int, float, str]) -> None:
         shutil.rmtree(self[key].path)
 
@@ -177,7 +200,7 @@ class FoamCaseRunBase(FoamCaseBase):
 
         return script
 
-    def __run_script(self, *, parallel: Optional[bool] = None) -> Optional[Path]:
+    def __run_script(self, *, parallel: Optional[bool]) -> Optional[Path]:
         """Return the path to the (All)run script, or None if no run script is found."""
         run = self.path / "run"
         run_parallel = self.path / "run-parallel"
@@ -263,7 +286,7 @@ class FoamCaseRunBase(FoamCaseBase):
 
         return type(self)(dst)
 
-    def _clean_calls(self, *, check: bool = False) -> Generator[Any, None, None]:
+    def _clean_calls(self, *, check: bool) -> Generator[Any, None, None]:
         script_path = self.__clean_script()
 
         if script_path is not None:
@@ -299,10 +322,10 @@ class FoamCaseRunBase(FoamCaseBase):
         self,
         cmd: Optional[Union[Sequence[Union[str, "os.PathLike[str]"]], str]] = None,
         *,
-        parallel: Optional[bool] = None,
-        cpus: Optional[int] = None,
-        check: bool = True,
-        log: bool = True,
+        parallel: Optional[bool],
+        cpus: Optional[int],
+        check: bool,
+        log: bool,
     ) -> Generator[Any, None, None]:
         if cmd is not None:
             if parallel:

foamlib/_cases/_sync.py

@@ -3,13 +3,7 @@ import shutil
 import sys
 from pathlib import Path
 from types import TracebackType
-from typing import (
-    Any,
-    Callable,
-    Optional,
-    Type,
-    Union,
-)
+from typing import Any, Callable, Optional, Type, Union, overload
 
 if sys.version_info >= (3, 9):
     from collections.abc import Collection, Sequence
@@ -21,6 +15,8 @@ if sys.version_info >= (3, 11):
 else:
     from typing_extensions import Self
 
+from .._files import FoamFieldFile
+from ._base import FoamCaseBase
 from ._run import FoamCaseRunBase
 from ._subprocess import run_sync
 from ._util import ValuedGenerator
@@ -37,6 +33,22 @@ class FoamCase(FoamCaseRunBase):
     :param path: The path to the case directory.
     """
 
+    class TimeDirectory(FoamCaseRunBase.TimeDirectory):
+        @property
+        def _case(self) -> "FoamCase":
+            return FoamCase(self.path.parent)
+
+        def cell_centers(self) -> FoamFieldFile:
+            """Write and return the cell centers."""
+            calls = ValuedGenerator(self._cell_centers_calls())
+
+            for _ in calls:
+                pass
+
+            print(calls.value)
+
+            return calls.value
+
     def __init__(self, path: Union["os.PathLike[str]", str] = Path()):
         super().__init__(path)
 
@@ -67,6 +79,23 @@ class FoamCase(FoamCaseRunBase):
     ) -> None:
         shutil.copytree(src, dest, symlinks=symlinks, ignore=ignore)
 
+    @overload
+    def __getitem__(
+        self, index: Union[int, float, str]
+    ) -> "FoamCase.TimeDirectory": ...
+
+    @overload
+    def __getitem__(self, index: slice) -> Sequence["FoamCase.TimeDirectory"]: ...
+
+    def __getitem__(
+        self, index: Union[int, slice, float, str]
+    ) -> Union["FoamCase.TimeDirectory", Sequence["FoamCase.TimeDirectory"]]:
+        ret = super().__getitem__(index)
+        if isinstance(ret, FoamCaseBase.TimeDirectory):
+            return FoamCase.TimeDirectory(ret)
+        else:
+            return [FoamCase.TimeDirectory(r) for r in ret]
+
     def __enter__(self) -> Self:
         return self
 
@@ -105,7 +134,9 @@ class FoamCase(FoamCaseRunBase):
         :param check: If True, raise a CalledProcessError if any command returns a non-zero exit code.
         :param log: If True, log the command output to a file.
         """
-        for _ in self._run_calls(cmd=cmd, parallel=parallel, check=check):
+        for _ in self._run_calls(
+            cmd=cmd, parallel=parallel, cpus=cpus, check=check, log=log
+        ):
             pass
 
     def block_mesh(self, *, check: bool = True) -> None:

foamlib/_files/_io.py

@@ -1,4 +1,5 @@
 import gzip
+import os
 import sys
 from copy import deepcopy
 from pathlib import Path
@@ -19,7 +20,7 @@ from ._parsing import Parsed
 
 
 class FoamFileIO:
-    def __init__(self, path: Union[str, Path]) -> None:
+    def __init__(self, path: Union["os.PathLike[str]", str]) -> None:
         self.path = Path(path).absolute()
 
         self.__contents: Optional[bytes] = None

{foamlib-0.6.1.dist-info → foamlib-0.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.1
+Version: 0.6.3
 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

foamlib-0.6.3.dist-info/RECORD

@@ -0,0 +1,21 @@
+foamlib/__init__.py,sha256=NChr4kydPt4FTxbO3l08Wo5RiKAPgfjfQsBsePeLjGo,436
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foamlib/_cases/__init__.py,sha256=eZXDwGfW_vNHx3pP2kwG1Z0NUUtnjUmvaSRdSGeWcVo,293
+foamlib/_cases/_async.py,sha256=v-oMQffE0tj6MSCiCKeIAOnDKBoQGCru59SmyULlO-c,7585
+foamlib/_cases/_base.py,sha256=4VWsu22VockyKgU_5tnSMeNrAkMgBKwZo2KGkV65rRQ,6739
+foamlib/_cases/_run.py,sha256=oDE4FoLanS8XyPbCdr3gvKTkMcovDv4hBca2CTm-6qQ,12964
+foamlib/_cases/_subprocess.py,sha256=GTmHWy1LRD9ujpXJfSTXU2bf87GncpIA0VOR1rQW2fg,3633
+foamlib/_cases/_sync.py,sha256=1KssR__g9vR7JWCL0a0o3wa7U6YsJ1XUzK6YnKkMQ50,5873
+foamlib/_cases/_util.py,sha256=GNndpqw3Jg_S-Hxzl5vwRgD0czcTNb9NYHMhcfBoMBg,1493
+foamlib/_files/__init__.py,sha256=-UqB9YTH6mrJfXCX00kPTAAY20XG64u1MGPw_1ewLVs,148
+foamlib/_files/_base.py,sha256=zaFDjLE6jB7WtGWk8hfKusjLtlGu6CZV16AHJpRUibs,1929
+foamlib/_files/_files.py,sha256=DxM5JmXv19PJrqlKNwuP6SsB0nye6aN1hiPwble7fFM,15657
+foamlib/_files/_io.py,sha256=T8vTEmJDidL03qeX1PUJFND-_vaF0AuC_0lE_zxLz7Q,2447
+foamlib/_files/_parsing.py,sha256=DzgJ53QnohRQyLXn2zOs52RIQ7bJ_fS_S2Z7rmRyVK4,9023
+foamlib/_files/_serialization.py,sha256=pb8_cIVgRhGS_ZV2p3x8p5_lK1SS6xzQHscAYYuOgFY,3407
+foamlib/_files/_util.py,sha256=UMzXmTFgvbp46w6k3oEZJoYC98pFgEK6LN5uLOwrlCg,397
+foamlib-0.6.3.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.6.3.dist-info/METADATA,sha256=xn_MMu25aIOdq1LCNKkXjb2-qn1v-FxE07BUCH87rU0,6338
+foamlib-0.6.3.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+foamlib-0.6.3.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.6.3.dist-info/RECORD,,

foamlib-0.6.1.dist-info/RECORD

@@ -1,21 +0,0 @@
-foamlib/__init__.py,sha256=BVCe7vPVevu5BHTZMwbL8VQEQCStIT_j_p_4bGfVW1A,392
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib/_cases/__init__.py,sha256=C0mpRu7c-X-4uVMKmVrZhwIyhBNyvUoCv0o-BQ72RC0,236
-foamlib/_cases/_async.py,sha256=8x8Mkql6XPzMjH4t-NszAEDx4gpjNPnQiWxFkHrcFJU,6436
-foamlib/_cases/_base.py,sha256=1CUkkK4afBxDgP79dmho97WJdj-GLgYhnrCSf_52Eao,6604
-foamlib/_cases/_run.py,sha256=0xu5V3qvWnXYJvOh0GV8DM1gOiNc65frWJF3mviHPOM,12307
-foamlib/_cases/_subprocess.py,sha256=GTmHWy1LRD9ujpXJfSTXU2bf87GncpIA0VOR1rQW2fg,3633
-foamlib/_cases/_sync.py,sha256=PzwciC4kFfenlG0XOtbBMxd9EuQBChwxZGA3RDlmWXM,4752
-foamlib/_cases/_util.py,sha256=GNndpqw3Jg_S-Hxzl5vwRgD0czcTNb9NYHMhcfBoMBg,1493
-foamlib/_files/__init__.py,sha256=-UqB9YTH6mrJfXCX00kPTAAY20XG64u1MGPw_1ewLVs,148
-foamlib/_files/_base.py,sha256=zaFDjLE6jB7WtGWk8hfKusjLtlGu6CZV16AHJpRUibs,1929
-foamlib/_files/_files.py,sha256=DxM5JmXv19PJrqlKNwuP6SsB0nye6aN1hiPwble7fFM,15657
-foamlib/_files/_io.py,sha256=uSh5XlgukwJkQSLELa4mshRD2aTajNk5vr_ZsBImSeU,2423
-foamlib/_files/_parsing.py,sha256=DzgJ53QnohRQyLXn2zOs52RIQ7bJ_fS_S2Z7rmRyVK4,9023
-foamlib/_files/_serialization.py,sha256=pb8_cIVgRhGS_ZV2p3x8p5_lK1SS6xzQHscAYYuOgFY,3407
-foamlib/_files/_util.py,sha256=UMzXmTFgvbp46w6k3oEZJoYC98pFgEK6LN5uLOwrlCg,397
-foamlib-0.6.1.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.6.1.dist-info/METADATA,sha256=wCN0T5tNyAtSUx5k8ehwqjX05fJDV_vBbw4j-pTqNbI,6338
-foamlib-0.6.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-foamlib-0.6.1.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.6.1.dist-info/RECORD,,