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

pyfemtet/opt/interface/_femtet_with_nx/__init__.py

@@ -0,0 +1,3 @@
+from ._interface import FemtetWithNXInterface
+
+__all__ = ['FemtetWithNXInterface']

pyfemtet/opt/interface/_femtet_with_nx/_interface.py

@@ -0,0 +1,128 @@
+import os
+import json
+import subprocess
+
+import pandas as pd
+from dask.distributed import get_worker
+
+from pyfemtet.core import ModelError
+from pyfemtet.opt.interface import FemtetInterface, logger
+
+
+here, me = os.path.split(__file__)
+
+
+class FemtetWithNXInterface(FemtetInterface):
+    """Femtet with NX interface class.
+
+    Args:
+        prt_path: The path to the prt file.
+
+    For details of The other arguments, see ``FemtetInterface``.
+
+    """
+
+    _JOURNAL_PATH = os.path.abspath(os.path.join(here, 'update_model.py'))
+
+    def __init__(
+            self,
+            prt_path,
+            femprj_path=None,
+            model_name=None,
+            connect_method='auto',
+            strictly_pid_specify=True,
+    ):
+
+        # check NX installation
+        self.run_journal_path = os.path.join(os.environ.get('UGII_BASE_DIR'), 'NXBIN', 'run_journal.exe')
+        if not os.path.isfile(self.run_journal_path):
+            raise FileNotFoundError(
+                r'"%UGII_BASE_DIR%\NXBIN\run_journal.exe" が見つかりませんでした。環境変数 UGII_BASE_DIR 又は NX のインストール状態を確認してください。')
+
+        # 引数の処理
+        # dask サブプロセスのときは prt_path を worker space から取るようにする
+        try:
+            worker = get_worker()
+            space = worker.local_directory
+            self.prt_path = os.path.join(space, os.path.basename(prt_path))
+        except ValueError:  # get_worker に失敗した場合
+            self.prt_path = os.path.abspath(prt_path)
+
+        # FemtetInterface の設定 (femprj_path, model_name の更新など)
+        # + restore 情報の上書き
+        super().__init__(
+            femprj_path=femprj_path,
+            model_name=model_name,
+            connect_method=connect_method,
+            strictly_pid_specify=strictly_pid_specify,
+            prt_path=self.prt_path,
+        )
+
+    def check_param_value(self, name):
+        """Override FemtetInterface.check_param_value().
+
+        Do nothing because the parameter can be registered
+        to not only .femprj but also .prt.
+
+        """
+        pass
+
+    def _setup_before_parallel(self, client):
+        client.upload_file(
+            self.kwargs['prt_path'],
+            False
+        )
+        super()._setup_before_parallel(client)
+
+    def update_model(self, parameters: 'pd.DataFrame') -> None:
+        """Update .x_t"""
+
+        self.parameters = parameters.copy()
+
+        # Femtet が参照している x_t パスを取得する
+        x_t_path = self.Femtet.Gaudi.LastXTPath
+
+        # 前のが存在するならば消しておく
+        if os.path.isfile(x_t_path):
+            os.remove(x_t_path)
+
+        # 変数の json 文字列を作る
+        tmp_dict = {}
+        for i, row in parameters.iterrows():
+            tmp_dict[row['name']] = row['value']
+        str_json = json.dumps(tmp_dict)
+
+        # NX journal を使ってモデルを編集する
+        env = os.environ.copy()
+        subprocess.run(
+            [self.run_journal_path, self._JOURNAL_PATH, '-args', self.prt_path, str_json, x_t_path],
+            env=env,
+            shell=True,
+            cwd=os.path.dirname(self.prt_path)
+        )
+
+        # この時点で x_t ファイルがなければ NX がモデル更新に失敗しているはず
+        if not os.path.isfile(x_t_path):
+            raise ModelError
+
+        # モデルの再インポート
+        self._call_femtet_api(
+            self.Femtet.Gaudi.ReExecute,
+            False,
+            ModelError,  # 生きてるのに失敗した場合
+            error_message=f'モデル再構築に失敗しました.',
+            is_Gaudi_method=True,
+        )
+
+        # 処理を確定
+        self._call_femtet_api(
+            self.Femtet.Redraw,
+            False,  # 戻り値は常に None なのでこの変数に意味はなく None 以外なら何でもいい
+            ModelError,  # 生きてるのに失敗した場合
+            error_message=f'モデル再構築に失敗しました.',
+            is_Gaudi_method=True,
+        )
+
+        # femprj モデルの変数も更新
+        super().update_model(parameters)
+

pyfemtet/opt/interface/_femtet_with_sldworks.py

@@ -0,0 +1,174 @@
+import os
+import re
+from time import sleep, time
+
+import pandas as pd
+from dask.distributed import get_worker
+
+from win32com.client import DispatchEx
+from pythoncom import CoInitialize, CoUninitialize
+
+from pyfemtet.core import ModelError
+from pyfemtet.opt.interface import FemtetInterface, logger
+
+
+class FemtetWithSolidworksInterface(FemtetInterface):
+    # 定数の宣言
+    swThisConfiguration = 1  # https://help.solidworks.com/2023/english/api/swconst/SOLIDWORKS.Interop.swconst~SOLIDWORKS.Interop.swconst.swInConfigurationOpts_e.html
+    swAllConfiguration = 2
+    swSpecifyConfiguration = 3  # use with ConfigName argument
+    swSaveAsCurrentVersion = 0
+    swSaveAsOptions_Copy = 2  #
+    swSaveAsOptions_Silent = 1  # https://help.solidworks.com/2021/english/api/swconst/solidworks.interop.swconst~solidworks.interop.swconst.swsaveasoptions_e.html
+    swSaveWithReferencesOptions_None = 0  # https://help-solidworks-com.translate.goog/2023/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swSaveWithReferencesOptions_e.html?_x_tr_sl=auto&_x_tr_tl=ja&_x_tr_hl=ja&_x_tr_pto=wapp
+    swDocPART = 1  # https://help.solidworks.com/2023/english/api/swconst/SOLIDWORKS.Interop.swconst~SOLIDWORKS.Interop.swconst.swDocumentTypes_e.html
+
+    def __init__(
+            self,
+            sldprt_path,
+            femprj_path=None,
+            model_name=None,
+            connect_method='auto',
+            strictly_pid_specify=True,
+    ):
+        # 引数の処理
+        # dask サブプロセスのときは space 直下の sldprt_path を参照する
+        try:
+            worker = get_worker()
+            space = worker.local_directory
+            self.sldprt_path = os.path.join(space, os.path.basename(sldprt_path))
+        except ValueError:  # get_worker に失敗した場合
+            self.sldprt_path = os.path.abspath(sldprt_path)
+
+        # FemtetInterface の設定 (femprj_path, model_name の更新など)
+        # + restore 情報の上書き
+        super().__init__(
+            femprj_path=femprj_path,
+            model_name=model_name,
+            connect_method=connect_method,
+            strictly_pid_specify=strictly_pid_specify,
+            sldprt_path=self.sldprt_path,
+        )
+
+    def initialize_sldworks_connection(self):
+        # SolidWorks を捕まえ、ファイルを開く
+        self.swApp = DispatchEx('SLDWORKS.Application')
+        self.swApp.Visible = True
+
+        # open model
+        self.swApp.OpenDoc(self.sldprt_path, self.swDocPART)
+        self.swModel = self.swApp.ActiveDoc
+        self.swEqnMgr = self.swModel.GetEquationMgr
+        self.nEquation = self.swEqnMgr.GetCount
+
+    def check_param_value(self, param_name):
+        """Override FemtetInterface.check_param_value().
+
+        Do nothing because the parameter can be registered
+        to not only .femprj but also .SLDPRT.
+
+        """
+        pass
+
+    def _setup_before_parallel(self, client):
+        client.upload_file(
+            self.kwargs['sldprt_path'],
+            False
+        )
+        super()._setup_before_parallel(client)
+
+    def _setup_after_parallel(self):
+        CoInitialize()
+        self.initialize_sldworks_connection()
+
+    def update_model(self, parameters: pd.DataFrame):
+        """Update .x_t"""
+
+        self.parameters = parameters.copy()
+
+        # Femtet が参照している x_t パスを取得する
+        x_t_path = self.Femtet.Gaudi.LastXTPath
+
+        # 前のが存在するならば消しておく
+        if os.path.isfile(x_t_path):
+            os.remove(x_t_path)
+
+        # solidworks のモデルの更新
+        self.update_sw_model(parameters)
+
+        # export as x_t
+        self.swModel.SaveAs(x_t_path)
+
+        # 30 秒待っても x_t ができてなければエラー(COM なので)
+        timeout = 30
+        start = time()
+        while True:
+            if os.path.isfile(x_t_path):
+                break
+            if time() - start > timeout:
+                raise ModelError('モデル再構築に失敗しました')
+            sleep(1)
+
+        # モデルの再インポート
+        self._call_femtet_api(
+            self.Femtet.Gaudi.ReExecute,
+            False,
+            ModelError,  # 生きてるのに失敗した場合
+            error_message=f'モデル再構築に失敗しました.',
+            is_Gaudi_method=True,
+        )
+
+        # 処理を確定
+        self._call_femtet_api(
+            self.Femtet.Redraw,
+            False,  # 戻り値は常に None なのでこの変数に意味はなく None 以外なら何でもいい
+            ModelError,  # 生きてるのに失敗した場合
+            error_message=f'モデル再構築に失敗しました.',
+            is_Gaudi_method=True,
+        )
+
+        # femprj モデルの変数も更新
+        super().update_model(parameters)
+
+    def update_sw_model(self, parameters: pd.DataFrame):
+        """Update .sldprt"""
+        # df を dict に変換
+        user_param_dict = {}
+        for i, row in parameters.iterrows():
+            user_param_dict[row['name']] = row['value']
+
+        # プロパティを退避
+        buffer_aso = self.swEqnMgr.AutomaticSolveOrder
+        buffer_ar = self.swEqnMgr.AutomaticRebuild
+        self.swEqnMgr.AutomaticSolveOrder = False
+        self.swEqnMgr.AutomaticRebuild = False
+
+        for i in range(self.nEquation):
+            # name, equation の取得
+            current_equation = self.swEqnMgr.Equation(i)
+            current_name = self._get_name_from_equation(current_equation)
+            # 対象なら処理
+            if current_name in list(user_param_dict.keys()):
+                new_equation = f'"{current_name}" = {user_param_dict[current_name]}'
+                self.swEqnMgr.Equation(i, new_equation)
+
+        # 式の計算
+        # noinspection PyStatementEffect
+        self.swEqnMgr.EvaluateAll  # always returns -1
+
+        # プロパティをもとに戻す
+        self.swEqnMgr.AutomaticSolveOrder = buffer_aso
+        self.swEqnMgr.AutomaticRebuild = buffer_ar
+
+        # 更新する（ここで失敗はしうる）
+        result = self.swModel.EditRebuild3  # モデル再構築
+        if not result:
+            raise ModelError('モデル再構築に失敗しました')
+
+    def _get_name_from_equation(self, equation: str):
+        pattern = r'^\s*"(.+?)"\s*$'
+        matched = re.match(pattern, equation.split('=')[0])
+        if matched:
+            return matched.group(1)
+        else:
+            return None

pyfemtet/opt/opt/__init__.py

@@ -0,0 +1,8 @@
+from pyfemtet.opt.opt._base import AbstractOptimizer, logger
+from pyfemtet.opt.opt._optuna import OptunaOptimizer
+
+__all__ = [
+    'OptunaOptimizer',
+    'AbstractOptimizer',
+    'logger',
+]

pyfemtet/opt/opt/_base.py

@@ -0,0 +1,202 @@
+# typing
+from abc import ABC, abstractmethod
+
+# built-in
+import json
+from time import sleep
+
+# 3rd-party
+import numpy as np
+import pandas as pd
+
+# pyfemtet relative
+from pyfemtet.opt.interface import FemtetInterface
+from pyfemtet.opt._femopt_core import OptimizationStatus
+
+# logger
+import logging
+from pyfemtet.logger import get_logger
+logger = get_logger('opt')
+logger.setLevel(logging.INFO)
+
+
+class AbstractOptimizer(ABC):
+    """Abstract base class for an interface of optimization library.
+
+    Attributes:
+        fem (FEMInterface): The finite element method object.
+        fem_class (type): The class of the finite element method object.
+        fem_kwargs (dict): The keyword arguments used to instantiate the finite element method object.
+        parameters (pd.DataFrame): The parameters used in the optimization.
+        objectives (dict): A dictionary containing the objective functions used in the optimization.
+        constraints (dict): A dictionary containing the constraint functions used in the optimization.
+        entire_status (OptimizationStatus): The status of the entire optimization process.
+        history (History): An actor object that records the history of each iteration in the optimization process.
+        worker_status (OptimizationStatus): The status of each worker in a distributed computing environment.
+        message (str): A message associated with the current state of the optimization process.
+        seed (int or None): The random seed used for random number generation during the optimization process.
+        timeout (float or int or None): The maximum time allowed for each iteration of the optimization process. If exceeded, it will be interrupted and terminated early.
+        n_trials (int or None): The maximum number of trials allowed for each iteration of the optimization process. If exceeded, it will be interrupted and terminated early.
+        is_cluster (bool): Flag indicating if running on a distributed computing cluster.
+
+    """
+
+    def __init__(self):
+        self.fem = None
+        self.fem_class = None
+        self.fem_kwargs = dict()
+        self.parameters = pd.DataFrame()
+        self.objectives = dict()
+        self.constraints = dict()
+        self.entire_status = None  # actor
+        self.history = None  # actor
+        self.worker_status = None  # actor
+        self.message = ''
+        self.seed = None
+        self.timeout = None
+        self.n_trials = None
+        self.is_cluster = False
+        self.subprocess_idx = None
+
+    def f(self, x):
+        """Get x, update fem analysis, return objectives (and constraints)."""
+        # interruption の実装は具象クラスに任せる
+
+        # x の更新
+        self.parameters['value'] = x
+
+        # FEM の更新
+        logger.debug('fem.update() start')
+        self.fem.update(self.parameters)
+
+        # y, _y, c の更新
+        logger.debug('calculate y start')
+        y = [obj.calc(self.fem) for obj in self.objectives.values()]
+
+        logger.debug('calculate _y start')
+        _y = [obj.convert(value) for obj, value in zip(self.objectives.values(), y)]
+
+        logger.debug('calculate c start')
+        c = [cns.calc(self.fem) for cns in self.constraints.values()]
+
+        logger.debug('history.record start')
+        self.history.record(
+            self.parameters,
+            self.objectives,
+            self.constraints,
+            y,
+            c,
+            self.message,
+        )
+
+        logger.debug('history.record end')
+        return np.array(y), np.array(_y), np.array(c)
+
+    def _reconstruct_fem(self, skip_reconstruct=False):
+        """Reconstruct FEMInterface in a subprocess."""
+        # reconstruct fem
+        if not skip_reconstruct:
+            self.fem = self.fem_class(**self.fem_kwargs)
+
+        # COM 定数の restore
+        for obj in self.objectives.values():
+            obj._restore_constants()
+        for cns in self.constraints.values():
+            cns._restore_constants()
+
+    def get_parameter(self, format='dict'):
+        """Returns the parameters in the specified format.
+
+        Args:
+            format (str, optional): The desired format of the parameters. Can be 'df' (DataFrame), 'values', or 'dict'. Defaults to 'dict'.
+
+        Returns:
+            object: The parameters in the specified format.
+
+        Raises:
+            ValueError: If an invalid format is provided.
+
+        """
+        if format == 'df':
+            return self.parameters
+        elif format == 'values' or format == 'value':
+            return self.parameters.value.values
+        elif format == 'dict':
+            ret = {}
+            for i, row in self.parameters.iterrows():
+                ret[row['name']] = row.value
+            return ret
+        else:
+            raise ValueError('get_parameter() got invalid format: {format}')
+
+    def _check_interruption(self):
+        """"""
+        if self.entire_status.get() == OptimizationStatus.INTERRUPTING:
+            self.worker_status.set(OptimizationStatus.INTERRUPTING)
+            self._finalize()
+            return True
+        else:
+            return False
+
+    def _finalize(self):
+        """Destruct fem and set worker status."""
+        del self.fem
+        self.worker_status.set(OptimizationStatus.TERMINATED)
+
+    def _run(
+            self,
+            subprocess_idx,
+            worker_status_list,
+            wait_setup,
+            skip_set_fem=False,
+    ) -> None:
+
+        # 自分の worker_status の取得
+        self.subprocess_idx = subprocess_idx
+        self.worker_status = worker_status_list[subprocess_idx]
+        self.worker_status.set(OptimizationStatus.LAUNCHING_FEM)
+
+        if self._check_interruption():
+            return None
+
+        # set_fem をはじめ、終了したらそれを示す
+        if not skip_set_fem:  # なくても動く？？
+            self._reconstruct_fem()
+        self.fem._setup_after_parallel()
+        self.worker_status.set(OptimizationStatus.WAIT_OTHER_WORKERS)
+
+        # wait_setup or not
+        if wait_setup:
+            while True:
+                if self._check_interruption():
+                    return None
+                # 他のすべての worker_status が wait 以上になったら break
+                if all([ws.get() >= OptimizationStatus.WAIT_OTHER_WORKERS for ws in worker_status_list]):
+                    break
+                sleep(1)
+        else:
+            if self._check_interruption():
+                return None
+
+        # set status running
+        if self.entire_status.get() < OptimizationStatus.RUNNING:
+            self.entire_status.set(OptimizationStatus.RUNNING)
+        self.worker_status.set(OptimizationStatus.RUNNING)
+
+        # run and finalize
+        try:
+            self.run()
+        finally:
+            self._finalize()
+
+        return None
+
+    @abstractmethod
+    def run(self) -> None:
+        """Start calcuration using optimization library."""
+        pass
+
+    @abstractmethod
+    def _setup_before_parallel(self, *args, **kwargs):
+        """Setup before parallel processes are launched."""
+        pass