pyfemtet 0.4.10__py3-none-any.whl → 0.4.12__py3-none-any.whl

pyfemtet/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.10"
+__version__ = "0.4.12"

pyfemtet/_test_util.py

@@ -15,6 +15,32 @@ from femtetutils import util
 from pyfemtet.opt import FEMOpt
 
 
+class SuperSphere:
+    def __init__(self, n):
+        self.n = n
+
+    def x(self, radius, *angles):
+        assert len(angles) == self.n - 1, 'invalid angles length'
+
+        out = []
+
+        for i in range(self.n):
+            if i == 0:
+                out.append(radius * np.cos(angles[0]))
+            elif i < self.n - 1:
+                product = radius
+                for j in range(i):
+                    product *= np.sin(angles[j])
+                product *= np.cos(angles[i])
+                out.append(product)
+            else:
+                product = radius
+                for j in range(i):
+                    product *= np.sin(angles[j])
+                out.append(product)
+        return out
+
+
 def _open_femprj(femprj_path):
     Femtet = Dispatch('FemtetMacro.Femtet')
     for _ in tqdm(range(5), 'wait for dispatch Femtet'):

pyfemtet/opt/__init__.py

@@ -4,7 +4,7 @@ from pyfemtet.opt.interface import FemtetInterface
 from pyfemtet.opt.interface import FemtetWithNXInterface
 from pyfemtet.opt.interface import FemtetWithSolidworksInterface
 
-from pyfemtet.opt.opt import OptunaOptimizer
+from pyfemtet.opt.opt import OptunaOptimizer, ScipyOptimizer
 from pyfemtet.opt.opt import AbstractOptimizer
 
 from pyfemtet.opt._femopt import FEMOpt

pyfemtet/opt/_femopt.py

@@ -13,7 +13,7 @@ from dask.distributed import LocalCluster, Client
 # pyfemtet relative
 from pyfemtet.opt.interface import FEMInterface, FemtetInterface
 from pyfemtet.opt.opt import AbstractOptimizer, OptunaOptimizer
-from pyfemtet.opt.visualization._monitor import ProcessMonitorApp
+from pyfemtet.opt.visualization.process_monitor.application import main as process_monitor_main
 from pyfemtet.opt._femopt_core import (
     _check_bound,
     _is_access_gogh,
@@ -107,6 +107,7 @@ class FEMOpt:
             initial_value: float or None = None,
             lower_bound: float or None = None,
             upper_bound: float or None = None,
+            step: float or None = None,
             memo: str = ''
     ):
         """Adds a parameter to the optimization problem.
@@ -133,8 +134,9 @@ class FEMOpt:
         d = {
             'name': name,
             'value': float(initial_value),
-            'lb': float(lower_bound),
-            'ub': float(upper_bound),
+            'lb': float(lower_bound) if lower_bound is not None else None,
+            'ub': float(upper_bound) if upper_bound is not None else None,
+            'step': float(step) if step is not None else None,
             'memo': memo,
         }
         pdf = pd.DataFrame(d, index=[0], dtype=object)
@@ -314,6 +316,34 @@ class FEMOpt:
 
         """
 
+        # method checker
+        if n_parallel > 1:
+            self.opt.method_checker.check_parallel()
+
+        if timeout is not None:
+            self.opt.method_checker.check_timeout()
+
+        if len(self.opt.objectives) > 1:
+            self.opt.method_checker.check_multi_objective()
+
+        if len(self.opt.constraints) > 0:
+            self.opt.method_checker.check_constraint()
+
+        for key, value in self.opt.constraints.items():
+            if value.strict:
+                self.opt.method_checker.check_strict_constraint()
+                break
+
+        if self.opt.seed is not None:
+            self.opt.method_checker.check_seed()
+
+        is_incomplete_bounds = False
+        for _, row in self.opt.parameters.iterrows():
+            lb, ub = row['lb'], row['ub']
+            is_incomplete_bounds = is_incomplete_bounds + (lb is None) + (ub is None)
+        if is_incomplete_bounds:
+            self.opt.method_checker.check_incomplete_bounds()
+
         # 共通引数
         self.opt.n_trials = n_trials
         self.opt.timeout = timeout
@@ -574,6 +604,12 @@ def _start_monitor_server(
         host=None,
         port=None,
 ):
-    monitor = ProcessMonitorApp(history, status, worker_addresses, worker_status_list)
-    monitor.start_server(host, port)
+    process_monitor_main(
+        history,
+        status,
+        worker_addresses,
+        worker_status_list,
+        host,
+        port,
+    )
     return 'Exit monitor server process gracefully'

pyfemtet/opt/interface/_base.py

@@ -43,7 +43,12 @@ class FEMInterface(ABC):
         pass
 
     def update_parameter(self, parameters: pd.DataFrame, with_warning=False) -> Optional[List[str]]:
-        """Updates only FEM variables (if implemented in concrete class)."""
+        """Updates only FEM variables (if implemented in concrete class).
+
+        If this method is implemented,
+        it is able to get parameter via FEMInterface.
+
+        """
         pass
 
     def _setup_before_parallel(self, client) -> None:

pyfemtet/opt/interface/_femtet.py

@@ -3,15 +3,19 @@ from typing import Optional, List
 import os
 import sys
 from time import sleep, time
-import signal
 
 import pandas as pd
 import psutil
 from dask.distributed import get_worker
 
-from pywintypes import com_error
+# noinspection PyUnresolvedReferences
+from pywintypes import com_error, error
+# noinspection PyUnresolvedReferences
 from pythoncom import CoInitialize, CoUninitialize
+# noinspection PyUnresolvedReferences
 from win32com.client import constants
+import win32con
+import win32gui
 from femtetutils import util
 
 from pyfemtet.core import (
@@ -31,6 +35,10 @@ from pyfemtet.dispatch_extensions import (
 from pyfemtet.opt.interface import FEMInterface, logger
 
 
+def post_activate_message(hwnd):
+    win32gui.PostMessage(hwnd, win32con.WM_ACTIVATE, win32con.WA_ACTIVE, 0)
+
+
 class FemtetInterface(FEMInterface):
     """Concrete class for the interface with Femtet.
 
@@ -113,7 +121,7 @@ class FemtetInterface(FEMInterface):
         if self.original_femprj_path is None:
             # dask worker でなければ original のはず
             try:
-                worker = get_worker()
+                _ = get_worker()
             except ValueError:
                 self.original_femprj_path = self.femprj_path
 
@@ -252,7 +260,7 @@ class FemtetInterface(FEMInterface):
 
         """
 
-        # FIXME: Gaudi へのアクセスなど、self.Femtet.Gaudi.somefunc() のような場合、この関数を呼び出す前に Gaudi へのアクセスの時点で com_error が起こる
+        # FIXME: Gaudi へのアクセスなど、self.Femtet.Gaudi.SomeFunc() のような場合、この関数を呼び出す前に Gaudi へのアクセスの時点で com_error が起こる
         # FIXME: => 文字列で渡して eval() すればよい。
 
         if args is None:
@@ -282,9 +290,16 @@ class FemtetInterface(FEMInterface):
 
         # API を実行
         try:
-            returns = fun(*args, **kwargs)
-        except com_error:
+            # 解析結果を開いた状態で Gaudi.Activate して ReExecute する場合、ReExecute の前後にアクティブ化イベントが必要
+            if fun.__name__ == 'ReExecute':
+                post_activate_message(self.Femtet.hWnd)  # can raise pywintypes.error
+                returns = fun(*args, **kwargs)
+                post_activate_message(self.Femtet.hWnd)
+            else:
+                returns = fun(*args, **kwargs)
+        except (com_error, error):
             # パターン 2 エラーが生じたことは確定なのでエラーが起こるよう returns を作る
+            # com_error ではなく error の場合はおそらく Femtet が落ちている
             if ret_for_check_idx is None:
                 returns = return_value_if_failed
             else:
@@ -665,6 +680,13 @@ class FemtetInterface(FEMInterface):
         )
         return out
 
+    @staticmethod
+    def create_pdt_path(femprj_path, model_name, trial):
+        result_dir = femprj_path.replace('.femprj', '.Results')
+        pdt_path = os.path.join(result_dir, model_name + f'_trial{trial}.pdt')
+        return pdt_path
+
+    # noinspection PyMethodOverriding
     @staticmethod
     def postprocess_func(
             trial: int,
@@ -676,7 +698,7 @@ class FemtetInterface(FEMInterface):
     ):
         result_dir = original_femprj_path.replace('.femprj', '.Results')
         if pdt_file_content is not None:
-            pdt_path = os.path.join(result_dir, model_name + f'_trial{trial}.pdt')
+            pdt_path = FemtetInterface.create_pdt_path(original_femprj_path, model_name, trial)
             with open(pdt_path, 'wb') as f:
                 f.write(pdt_file_content)
 
@@ -710,13 +732,12 @@ class FemtetInterface(FEMInterface):
         jpg_path = os.path.join(result_dir, self.model_name + '.jpg')
 
         # モデル表示画面の設定
-        self.Femtet.SetWindowSize(200, 200)
+        self.Femtet.SetWindowSize(600, 600)
         self.Femtet.Fit()
-        self.Femtet.ViewNumeric.SetCoord(1, 1, 1)
 
         # ---モデルの画面を保存---
         self.Femtet.Redraw()  # 再描画
-        succeed = self.Femtet.SavePicture(jpg_path, 200, 200, 80)
+        succeed = self.Femtet.SavePicture(jpg_path, 600, 600, 80)
 
         self.Femtet.RedrawMode = True  # 逐一の描画をオン
 
@@ -745,6 +766,7 @@ class _UnPicklableNoFEM(FemtetInterface):
     Femtet = None
     quit_when_destruct = False
 
+    # noinspection PyMissingConstructor
     def __init__(self):
         CoInitialize()
         self.unpicklable_member = Dispatch('FemtetMacro.Femtet')

pyfemtet/opt/interface/_femtet_parametric.py

@@ -1,36 +1,15 @@
+from femtetutils import util
 from pyfemtet.dispatch_extensions import _get_pid
 
-import winreg
 import ctypes
 
 
-def _get_dll(Femtet):
-    femtet_major_version = _get_femtet_major_version(Femtet)
-    dll_path = _get_parametric_dll_path(femtet_major_version)
+def _get_dll():
+    femtet_exe_path = util.get_femtet_exe_path()
+    dll_path = femtet_exe_path.replace('Femtet.exe', 'ParametricIF.dll')
     return ctypes.cdll.LoadLibrary(dll_path)
 
 
-def _get_femtet_major_version(Femtet):
-    from pyfemtet.core import _version
-    version_int8 = _version(Femtet=Femtet)
-    return str(version_int8)[0:4]
-
-
-def _get_parametric_dll_path(femtet_major_version) -> str:
-    key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r'SOFTWARE\FemtetInfo\InstallVersion\x64')
-    _, nValues, _ = winreg.QueryInfoKey(key)
-    for i in range(nValues):
-        name, data, _ = winreg.EnumValue(key, i)
-        if name == str(femtet_major_version):
-            winreg.CloseKey(key)
-            import os
-            dll_path = os.path.join(data, 'Program', 'ParametricIF.dll')
-            return dll_path
-    # ここまで来ていたら失敗
-    winreg.CloseKey(key)
-    raise RuntimeError('パラメトリック解析機能へのアクセスに失敗しました')
-
-
 def _get_dll_with_set_femtet(Femtet):
     dll = _get_dll(Femtet)
     pid = _get_pid(Femtet.hWnd)
@@ -40,6 +19,7 @@ def _get_dll_with_set_femtet(Femtet):
 
 
 def _get_prm_result_names(Femtet):
+    """Used by pyfemtet-opt-gui"""
     out = []
 
     # load dll and set target femtet

pyfemtet/opt/opt/__init__.py

@@ -1,7 +1,9 @@
-from pyfemtet.opt.opt._base import AbstractOptimizer, logger
+from pyfemtet.opt.opt._base import AbstractOptimizer, logger, OptimizationMethodChecker
 from pyfemtet.opt.opt._optuna import OptunaOptimizer
+from pyfemtet.opt.opt._scipy import ScipyOptimizer
 
 __all__ = [
+    'ScipyOptimizer',
     'OptunaOptimizer',
     'AbstractOptimizer',
     'logger',

pyfemtet/opt/opt/_base.py

@@ -20,6 +20,77 @@ logger = get_logger('opt')
 logger.setLevel(logging.INFO)
 
 
+class OptimizationMethodChecker:
+    """Check implementation of PyFemtet functions."""
+
+    def __init__(self, opt):
+        self.opt = opt
+
+    def check_parallel(self, raise_error=True):
+        function = 'parallel computing'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_timeout(self, raise_error=True):
+        function = 'timeout'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_multi_objective(self, raise_error=True):
+        function = 'multi-objective'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_strict_constraint(self, raise_error=True):
+        function = 'strict_constraint'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_constraint(self, raise_error=True):
+        function = 'strict_constraint'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_skip(self, raise_error=True):
+        function = 'skip'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_seed(self, raise_error=True):
+        function = 'random seed setting'
+        message = f'{type(self.opt)} is not implement {function}'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+    def check_incomplete_bounds(self, raise_error=True):
+        function = 'optimize with no or incomplete bounds'
+        message = f'{type(self.opt)} is not implement "{function}"'
+        if raise_error:
+            raise NotImplementedError(message)
+        else:
+            logger.warning(message)
+
+
 class AbstractOptimizer(ABC):
     """Abstract base class for an interface of optimization library.
 
@@ -45,9 +116,9 @@ class AbstractOptimizer(ABC):
         self.fem = None
         self.fem_class = None
         self.fem_kwargs = dict()
-        self.parameters = pd.DataFrame()
-        self.objectives = dict()
-        self.constraints = dict()
+        self.parameters: pd.DataFrame = pd.DataFrame()
+        self.objectives: dict = dict()
+        self.constraints: dict = dict()
         self.entire_status = None  # actor
         self.history = None  # actor
         self.worker_status = None  # actor
@@ -58,6 +129,7 @@ class AbstractOptimizer(ABC):
         self.is_cluster = False
         self.subprocess_idx = None
         self._is_error_exit = False
+        self.method_checker: OptimizationMethodChecker = OptimizationMethodChecker(self)
 
     def f(self, x):
         """Get x, update fem analysis, return objectives (and constraints)."""
@@ -65,10 +137,15 @@ class AbstractOptimizer(ABC):
 
         # x の更新
         self.parameters['value'] = x
+        logger.info(f'Start calculation with input: {x}')
 
         # FEM の更新
         logger.debug('fem.update() start')
-        self.fem.update(self.parameters)
+        try:
+            self.fem.update(self.parameters)
+        except Exception as e:
+            logger.warning('An exception has occurred during FEM update.')
+            raise e
 
         # y, _y, c の更新
         logger.debug('calculate y start')
@@ -93,6 +170,9 @@ class AbstractOptimizer(ABC):
         )
 
         logger.debug('history.record end')
+
+        logger.info(f'End calculation with output: {_y}')
+
         return np.array(y), np.array(_y), np.array(c)
 
     def _reconstruct_fem(self, skip_reconstruct=False):
@@ -191,10 +271,10 @@ class AbstractOptimizer(ABC):
         try:
             self.run()
         except Exception as e:
-            logger.error("================================")
-            logger.error("An unexpected error has occured!")
-            logger.error("================================")
-            logger.error(e)
+            logger.error("=================================")
+            logger.error("An unexpected error has occurred!")
+            logger.error("=================================")
+            logger.error(f'{type(e)}: {e}')
             self._is_error_exit = True
             self.worker_status.set(OptimizationStatus.CRASHED)
         finally:

pyfemtet/opt/opt/_optuna.py

@@ -12,15 +12,29 @@ from optuna.study import MaxTrialsCallback
 
 # pyfemtet relative
 from pyfemtet.opt._femopt_core import OptimizationStatus, generate_lhs
-from pyfemtet.opt.opt import AbstractOptimizer, logger
+from pyfemtet.opt.opt import AbstractOptimizer, logger, OptimizationMethodChecker
 from pyfemtet.core import MeshError, ModelError, SolveError
 
 # filter warnings
 import warnings
 from optuna.exceptions import ExperimentalWarning
+
+
+optuna.logging.set_verbosity(optuna.logging.ERROR)
+
 warnings.filterwarnings('ignore', category=ExperimentalWarning)
 
 
+class OptunaMethodChecker(OptimizationMethodChecker):
+    def check_multi_objective(self, raise_error=True): return True
+    def check_timeout(self, raise_error=True): return True
+    def check_parallel(self, raise_error=True): return True
+    def check_constraint(self, raise_error=True): return True
+    def check_strict_constraint(self, raise_error=True): return True
+    def check_skip(self, raise_error=True): return True
+    def check_seed(self, raise_error=True): return True
+
+
 class OptunaOptimizer(AbstractOptimizer):
 
     def __init__(
@@ -38,6 +52,7 @@ class OptunaOptimizer(AbstractOptimizer):
         self.sampler_kwargs = dict() if sampler_kwargs is None else sampler_kwargs
         self.additional_initial_parameter = []
         self.additional_initial_methods = add_init_method if hasattr(add_init_method, '__iter__') else [add_init_method]
+        self.method_checker = OptunaMethodChecker(self)
 
     def _objective(self, trial):
 
@@ -50,7 +65,7 @@ class OptunaOptimizer(AbstractOptimizer):
         # candidate x
         x = []
         for i, row in self.parameters.iterrows():
-            v = trial.suggest_float(row['name'], row['lb'], row['ub'])
+            v = trial.suggest_float(row['name'], row['lb'], row['ub'], step=row['step'])
             x.append(v)
         x = np.array(x).astype(float)
 

pyfemtet/opt/opt/_scipy.py

@@ -0,0 +1,144 @@
+# typing
+import logging
+from typing import Iterable
+
+# built-in
+import os
+
+# 3rd-party
+import numpy as np
+import pandas as pd
+import scipy.optimize
+from scipy.optimize import minimize, OptimizeResult
+
+# pyfemtet relative
+from pyfemtet.opt._femopt_core import OptimizationStatus, generate_lhs
+from pyfemtet.opt.opt import AbstractOptimizer, logger, OptimizationMethodChecker
+from pyfemtet.core import MeshError, ModelError, SolveError
+
+
+class StopIteration2(Exception):
+    pass
+
+
+class StopIterationCallback:
+    def __init__(self, opt):
+        self.opt: ScipyOptimizer = opt
+        self.res: OptimizeResult = None
+
+    def stop_iteration(self):
+        # stop iteration gimmick
+        # https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
+        if self.opt.minimize_kwargs['method'] == "trust-constr":
+            raise StopIteration2  # supports nothing
+        elif (
+                self.opt.minimize_kwargs['method'] == 'TNC'
+                or self.opt.minimize_kwargs['method'] == 'SLSQP'
+                or self.opt.minimize_kwargs['method'] == 'COBYLA'
+        ):
+            raise StopIteration2  # supports xk
+        else:
+            raise StopIteration  # supports xk , intermediate_result and StopIteration
+
+
+    def __call__(self, xk=None, intermediate_result=None):
+        self.res = intermediate_result
+        if self.opt.entire_status.get() == OptimizationStatus.INTERRUPTING:
+            self.opt.worker_status.set(OptimizationStatus.INTERRUPTING)
+            self.stop_iteration()
+
+
+class ScipyMethodChecker(OptimizationMethodChecker):
+    def check_incomplete_bounds(self, raise_error=True): return True
+
+
+class ScipyOptimizer(AbstractOptimizer):
+
+    def __init__(
+            self,
+            **minimize_kwargs,
+    ):
+        """
+        Args:
+            **minimize_kwargs: Kwargs of `scipy.optimize.minimize`.
+        """
+        super().__init__()
+
+        # define members
+        self.minimize_kwargs: dict = dict(
+            method='L-BFGS-B',
+        )
+        self.minimize_kwargs.update(minimize_kwargs)
+        self.res: OptimizeResult = None
+        self.method_checker: OptimizationMethodChecker = ScipyMethodChecker(self)
+        self.stop_iteration_callback = StopIterationCallback(self)
+
+    def _objective(self, x: np.ndarray):  # x: candidate parameter
+        # update parameter
+        self.parameters['value'] = x
+        self.fem.update_parameter(self.parameters)
+
+        # strict constraints
+        ...
+
+        # fem
+        try:
+            _, obj_values, cns_values = self.f(x)
+        except (ModelError, MeshError, SolveError) as e:
+            logger.info(e)
+            logger.info('以下の変数で FEM 解析に失敗しました。')
+            print(self.get_parameter('dict'))
+
+            # 現状、エラーが起きたらスキップできない
+            raise StopIteration2
+
+        # constraints
+        ...
+
+        # # check interruption command
+        # if self.entire_status.get() == OptimizationStatus.INTERRUPTING:
+        #     self.worker_status.set(OptimizationStatus.INTERRUPTING)
+        #     raise StopOptimize
+
+        # objectives to objective
+
+        return obj_values[0]
+
+    def _setup_before_parallel(self):
+        pass
+
+    def run(self):
+
+        # create init
+        x0 = self.parameters['value'].values
+
+        # create bounds
+        if 'bounds' not in self.minimize_kwargs.keys():
+            bounds = []
+            for i, row in self.parameters.iterrows():
+                lb, ub = row['lb'], row['ub']
+                if lb is None: lb = -np.inf
+                if ub is None: ub = np.inf
+                bounds.append([lb, ub])
+            self.minimize_kwargs.update(
+                {'bounds': bounds}
+            )
+
+        # run optimize
+        try:
+            res = minimize(
+                fun=self._objective,
+                x0=x0,
+                **self.minimize_kwargs,
+                callback=self.stop_iteration_callback,
+            )
+        except StopIteration2:
+            res = None
+            logger.warn('Optimization has been interrupted. '
+                        'Note that you cannot acquire the OptimizationResult '
+                        'in case of `trust-constr`, `TNC`, `SLSQP` or `COBYLA`.')
+
+        if res is None:
+            self.res = self.stop_iteration_callback.res
+        else:
+            self.res = res