pyfemtet 0.3.12__py3-none-any.whl → 0.4.1__py3-none-any.whl

pyfemtet/opt/interface/__init__.py

@@ -0,0 +1,15 @@
+from pyfemtet.opt.interface._base import FEMInterface, logger
+from pyfemtet.opt.interface._base import NoFEM
+from pyfemtet.opt.interface._femtet import FemtetInterface
+from pyfemtet.opt.interface._femtet_with_sldworks import FemtetWithSolidworksInterface
+from pyfemtet.opt.interface._femtet_with_nx import FemtetWithNXInterface
+
+
+__all__ = [
+    'FEMInterface',
+    'NoFEM',
+    'FemtetInterface',
+    'FemtetWithNXInterface',
+    'FemtetWithSolidworksInterface',
+    'logger',
+]

pyfemtet/opt/interface/_base.py

@@ -0,0 +1,71 @@
+from typing import Optional, List
+
+import os
+from abc import ABC, abstractmethod
+
+import pandas as pd
+
+import logging
+from pyfemtet.logger import get_logger
+logger = get_logger('FEM')
+logger.setLevel(logging.INFO)
+
+
+here, me = os.path.split(__file__)
+
+
+class FEMInterface(ABC):
+    """Abstract base class for the interface with FEM software.
+
+    Stores information necessary to restore FEMInterface instance in a subprocess.
+
+    The concrete class should call super().__init__() with the desired arguments when restoring.
+
+    Args:
+        **kwargs: keyword arguments for FEMInterface (re)constructor.
+
+    """
+
+    def __init__(
+            self,
+            **kwargs
+    ):
+        # restore のための情報保管
+        self.kwargs = kwargs
+
+    @abstractmethod
+    def update(self, parameters: pd.DataFrame) -> None:
+        """Updates the FEM analysis based on the proposed parameters."""
+        raise NotImplementedError('update() must be implemented.')
+
+    def check_param_value(self, param_name) -> float or None:
+        """Checks the value of a parameter in the FEM model (if implemented in concrete class)."""
+        pass
+
+    def update_parameter(self, parameters: pd.DataFrame, with_warning=False) -> Optional[List[str]]:
+        """Updates only FEM variables (if implemented in concrete class)."""
+        pass
+
+    def _setup_before_parallel(self, client) -> None:
+        """Preprocessing before launching a dask worker (if implemented in concrete class).
+
+        Args:
+            client: dask client.
+            i.e. you can update associated files by
+            `client.upload_file(file_path)`
+            The file will be saved to dask-scratch-space directory
+            without any directory structure.
+
+        """
+        pass
+
+    def _setup_after_parallel(self):
+        """Preprocessing after launching a dask worker and before run optimization (if implemented in concrete class)."""
+        pass
+
+
+class NoFEM(FEMInterface):
+    """Interface with no FEM for debug."""
+
+    def update(self, parameters: pd.DataFrame) -> None:
+        pass