pyfemtet 0.4.6__py3-none-any.whl → 0.4.8__py3-none-any.whl

pyfemtet/opt/interface/_femtet.py

@@ -41,7 +41,7 @@ class FemtetInterface(FEMInterface):
             strictly_pid_specify (bool, optional): If True and connect_method=='new', search launched Femtet process strictly based on its process id.
             allow_without_project (bool, optional): Allow to launch Femtet with no project file. Default to False.
             open_result_with_gui (bool, optional): Open analysis result with Femtet GUI. Default to True.
-            parametric_output_indexes_use_as_objective (list of int, optional): Parametric output indexes which will be used as objective functions. Parametric output should be set on Femtet parametric analysis dialog. Note that output 'No.' in dialog is starts with 1, but this 'index' is starts with 0. Default to None.
+            parametric_output_indexes_use_as_objective (dict, optional): Parametric output indexes and their directions which will be used as objective functions. Parametric output should be set on Femtet parametric analysis dialog. Note that output 'No.' in dialog is starts with 1, but this 'index' is starts with 0. The key is the 'index', the value is direction ('maximize', 'minimize' or float). Default to None.
 
         Warning:
             Even if you specify ``strictly_pid_specify=True`` on the constructor,
@@ -59,9 +59,10 @@ class FemtetInterface(FEMInterface):
             self,
             femprj_path=None,
             model_name=None,
-            connect_method='auto',
-            strictly_pid_specify=True,
-            allow_without_project=False,
+            connect_method='auto',  # dask worker では __init__ の中で 'new' にするので super() の引数にしない。（しても意味がない）
+            save_pdt='all',  # 'all' or None
+            strictly_pid_specify=True,  # dask worker では True にしたいので super() の引数にしない。
+            allow_without_project=False,  # main でのみ True を許容したいので super() の引数にしない。
             open_result_with_gui=True,
             parametric_output_indexes_use_as_objective=None,
             **kwargs  # 継承されたクラスからの引数
@@ -80,6 +81,7 @@ class FemtetInterface(FEMInterface):
         self.allow_without_project = allow_without_project
         self.original_femprj_path = self.femprj_path
         self.open_result_with_gui = open_result_with_gui
+        self.save_pdt = save_pdt
 
         # その他のメンバーの宣言や初期化
         self.Femtet = None
@@ -106,6 +108,15 @@ class FemtetInterface(FEMInterface):
         # 開かれたモデルに応じて femprj_path と model を更新する
         self._connect_and_open_femtet()
 
+        # original_fem_prj が None なら必ず
+        # dask worker でないプロセスがオリジナルファイルを開いている
+        if self.original_femprj_path is None:
+            # dask worker でなければ original のはず
+            try:
+                worker = get_worker()
+            except ValueError:
+                self.original_femprj_path = self.femprj_path
+
         # 接続した Femtet の種類に応じて del 時に quit するかどうか決める
         self.quit_when_destruct = self.connected_method == 'new'
 
@@ -117,26 +128,13 @@ class FemtetInterface(FEMInterface):
             model_name=self.model_name,
             open_result_with_gui=self.open_result_with_gui,
             parametric_output_indexes_use_as_objective=self.parametric_output_indexes_use_as_objective,
+            save_pdt=self.save_pdt,
             **kwargs
         )
 
     def __del__(self):
         if self.quit_when_destruct:
-            try:
-                # 強制終了 TODO: 自動保存を回避する
-                hwnd = self.Femtet.hWnd
-                pid = _get_pid(hwnd)
-                util.close_femtet(hwnd, 1, True)
-                start = time()
-                while psutil.pid_exists(pid):
-                    if time() - start > 30:  # 30 秒経っても存在するのは何かおかしい
-                        os.kill(pid, signal.SIGKILL)
-                        break
-                    sleep(1)
-                sleep(1)
-
-            except (AttributeError, OSError):  # already dead
-                pass
+            self.quit()
         # CoUninitialize()  # Win32 exception occurred releasing IUnknown at 0x0000022427692748
 
     def _connect_new_femtet(self):
@@ -199,8 +197,12 @@ class FemtetInterface(FEMInterface):
             cmd = f'{sys.executable} -m win32com.client.makepy FemtetMacro'
             os.system(cmd)
             message = 'Femtet python マクロ定数の設定が完了してないことを検出しました.'
-            message += '次のコマンドにより、設定は自動で行われました（python -m win32com.client.makepy FemtetMacro）.'
-            message += 'インタープリタを再起動してください.'
+            message += '設定は自動で行われました（python -m win32com.client.makepy FemtetMacro）.'
+            message += 'プログラムを再起動してください.'
+            print('================')
+            print(message)
+            print('================')
+            input('終了するには Enter を押してください。')
             raise RuntimeError(message)
 
         if self.Femtet is None:
@@ -270,7 +272,7 @@ class FemtetInterface(FEMInterface):
                     self.Femtet.Gaudi.Activate,
                     False,  # None 以外なら何でもいい
                     Exception,
-                    '解析モデルのオープンに失敗しました',
+                    'Gaudi のオープンに失敗しました',
                     print_indent=print_indent + 1
                 )
             except com_error:
@@ -430,14 +432,30 @@ class FemtetInterface(FEMInterface):
             Otherwise, no check is performed.
 
         """
-        if self._version() >= _version(2023, 1, 1):
-            variable_names = self.Femtet.GetVariableNames_py()
+        major, minor, bugfix = 2023, 1, 1
+        if self._version() >= _version(major, minor, bugfix):
+            try:
+                variable_names = self.Femtet.GetVariableNames_py()
+            except AttributeError as e:
+                message = 'GetVariableNames_py' + 'にアクセスできません。'
+                f'Femtet {major}.{minor}.{bugfix} 以降で「マクロの有効化」が行われていない可能性があります。'
+                'スタートメニューから、インストールされいてる Femtet と同一バージョンの「マクロ機能を有効化する」コマンドを管理者権限で実行してください。'
+                print('================')
+                logger.error(message)
+                print('================')
+                input('終了するには Enter を押してください。')
+                raise e
+                
             if variable_names is not None:
                 if param_name in variable_names:
                     return self.Femtet.GetVariableValue(param_name)
             message = f'Femtet 解析モデルに変数 {param_name} がありません.'
             message += f'現在のモデルに設定されている変数は {variable_names} です.'
             message += '大文字・小文字の区別に注意してください.'
+            print('================')
+            logger.error(message)
+            print('================')
+            input('終了するには Enter を押してください。')
             raise RuntimeError(message)
         else:
             return None
@@ -455,8 +473,9 @@ class FemtetInterface(FEMInterface):
             error_message='解析モデルが開かれていません',
         )
 
-        if self._version() >= _version(2023, 1, 1):
-            # Femtet の設計変数の更新
+        major, minor, bugfix = 2023, 1, 1
+        if self._version() >= _version(major, minor, bugfix):
+            # Femtet の設計変数の更新（2023.1.1 以降でマクロだけ古い場合はcheck_param_valueで引っかかっているはずなのでここはAttributeError をチェックしない）
             existing_variable_names = self._call_femtet_api(
                 fun=self.Femtet.GetVariableNames_py,
                 return_value_if_failed=False,  # 意味がない
@@ -591,7 +610,39 @@ class FemtetInterface(FEMInterface):
 
     def quit(self, timeout=1, force=True):
         """Force to terminate connected Femtet."""
-        util.close_femtet(self.Femtet.hWnd, timeout, force)
+        major, minor, bugfix = 2024, 0, 1
+        if self._version() >= _version(major, minor, bugfix):
+            # gracefully termination method without save project available from 2024.0.1
+            try:
+                self.Femtet.Exit(True)
+            except AttributeError as e:
+                message = 'Femtet.Exit()' + 'にアクセスできません。'
+                f'Femtet {major}.{minor}.{bugfix} 以降で「マクロの有効化」が行われていない可能性があります。'
+                'スタートメニューから、インストールされいてる Femtet と同一バージョンの「マクロ機能を有効化する」コマンドを管理者権限で実行してください。'
+                print('================')
+                logger.error(message)
+                print('================')
+                input('終了するには Enter を押してください。')
+                raise e
+
+        else:
+            hwnd = self.Femtet.hWnd
+
+            # terminate
+            util.close_femtet(hwnd, timeout, force)
+
+            try:
+                pid = _get_pid(hwnd)
+                start = time()
+                while psutil.pid_exists(pid):
+                    if time() - start > 30:  # 30 秒経っても存在するのは何かおかしい
+                        logger.error('Femtet の終了に失敗しました。')
+                        break
+                    sleep(1)
+                sleep(1)
+
+            except (AttributeError, OSError):  # already dead
+                pass
 
     def _setup_before_parallel(self, client):
         client.upload_file(
@@ -601,3 +652,128 @@ class FemtetInterface(FEMInterface):
 
     def _version(self):
         return _version(Femtet=self.Femtet)
+
+    def create_postprocess_args(self):
+        file_content = self.create_result_file_content()
+        jpg_content = self.create_jpg_content()
+
+        out = dict(
+            original_femprj_path=self.original_femprj_path,
+            model_name=self.model_name,
+            pdt_file_content=file_content,
+            jpg_file_content=jpg_content,
+        )
+        return out
+
+    @staticmethod
+    def postprocess_func(
+            trial: int,
+            original_femprj_path: str,
+            model_name: str,
+            pdt_file_content=None,
+            jpg_file_content=None,
+            dask_scheduler=None
+    ):
+        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')
+            with open(pdt_path, 'wb') as f:
+                f.write(pdt_file_content)
+
+        if jpg_file_content is not None:
+            jpg_path = os.path.join(result_dir, model_name + f'_trial{trial}.jpg')
+            with open(jpg_path, 'wb') as f:
+                f.write(jpg_file_content)
+
+    def create_result_file_content(self):
+        """Called after solve"""
+        if self.save_pdt == 'all':
+            # save to worker space
+            result_dir = self.femprj_path.replace('.femprj', '.Results')
+            pdt_path = os.path.join(result_dir, self.model_name + '.pdt')
+            succeed = self.Femtet.SavePDT(pdt_path, True)
+
+            # convert .pdt to ByteIO
+            if succeed:
+                with open(pdt_path, 'rb') as f:
+                    content = f.read()
+                return content
+
+            else:
+                raise Exception('pdt ファイルの保存でエラーが発生しました。')
+
+        else:
+            return None
+
+    def create_jpg_content(self):
+        result_dir = self.femprj_path.replace('.femprj', '.Results')
+        jpg_path = os.path.join(result_dir, self.model_name + '.jpg')
+
+        # モデル表示画面の設定
+        self.Femtet.SetWindowSize(200, 200)
+        self.Femtet.Fit()
+        self.Femtet.ViewNumeric.SetCoord(1, 1, 1)
+
+        # ---モデルの画面を保存---
+        self.Femtet.Redraw()  # 再描画
+        succeed = self.Femtet.SavePicture(jpg_path, 200, 200, 80)
+
+        self.Femtet.RedrawMode = True  # 逐一の描画をオン
+
+        if not succeed:
+            raise Exception('jpg ファイルの保存でエラーが発生しました。')
+
+        if not os.path.exists(jpg_path):
+            raise Exception('保存した jpg ファイルが見つかりませんでした。')
+
+        with open(jpg_path, 'rb') as f:
+            content = f.read()
+
+        return content
+
+
+from win32com.client import Dispatch, constants
+
+
+class _UnPicklableNoFEM(FemtetInterface):
+
+
+    original_femprj_path = 'dummy'
+    model_name = 'dummy'
+    parametric_output_indexes_use_as_objective = None
+    kwargs = dict()
+    Femtet = None
+    quit_when_destruct = False
+
+    def __init__(self):
+        CoInitialize()
+        self.unpicklable_member = Dispatch('FemtetMacro.Femtet')
+        self.cns = constants
+
+    def _setup_before_parallel(self, *args, **kwargs):
+        pass
+
+    def check_param_value(self, *args, **kwargs):
+        pass
+
+    def update_parameter(self, *args, **kwargs):
+        pass
+
+    def update(self, *args, **kwargs):
+        pass
+
+    def create_result_file_content(self):
+        """Called after solve"""
+
+        # save to worker space
+        with open(__file__, 'rb') as f:
+            content = f.read()
+
+        return content
+
+    def create_file_path(self, trial: int):
+        # return path of scheduler environment
+        here = os.path.dirname(__file__)
+        pdt_path = os.path.join(here, f'trial{trial}.pdt')
+        return pdt_path
+

pyfemtet/opt/interface/_femtet_parametric.py

@@ -55,20 +55,20 @@ def _get_prm_result_names(Femtet):
     return out
 
 
-def add_parametric_results_as_objectives(femopt, indexes) -> bool:
+def add_parametric_results_as_objectives(femopt, indexes, directions) -> bool:
     # load dll and set target femtet
     dll = _get_dll_with_set_femtet(femopt.fem.Femtet)
 
     # get objective names
     dll.GetPrmnResult.restype = ctypes.c_int
     n = dll.GetPrmnResult()
-    for i in indexes:
+    for i, direction in zip(indexes, directions):
         # objective name
         dll.GetPrmResultName.restype = ctypes.c_char_p
         result = dll.GetPrmResultName(i)
         name = result.decode('mbcs')
         # objective value function
-        femopt.add_objective(_parametric_objective, name, args=(i,))
+        femopt.add_objective(_parametric_objective, name, direction=direction, args=(i,))
     return True  # ここまで来たら成功
 
 

pyfemtet/opt/interface/_femtet_with_nx/_interface.py

@@ -17,6 +17,10 @@ class FemtetWithNXInterface(FemtetInterface):
 
     Args:
         prt_path: The path to the prt file.
+        export_curves(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
+        export_surfaces(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
+        export_solids(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
+        export_flattened_assembly(bool or None): Parasolid export setting of NX. If None, PyFemtet does not change the setting of NX. Defaults to None.
 
     For details of The other arguments, see ``FemtetInterface``.
 
@@ -27,9 +31,12 @@ class FemtetWithNXInterface(FemtetInterface):
     def __init__(
             self,
             prt_path,
+            export_curves: bool or None = None,
+            export_surfaces: bool or None = None,
+            export_solids: bool or None = None,
+            export_flattened_assembly: bool or None = None,
             **kwargs
     ):
-
         # 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):
@@ -45,10 +52,19 @@ class FemtetWithNXInterface(FemtetInterface):
         except ValueError:  # get_worker に失敗した場合
             self.prt_path = os.path.abspath(prt_path)
 
+        self.export_curves = export_curves
+        self.export_surfaces = export_surfaces
+        self.export_solids = export_solids
+        self.export_flattened_assembly = export_flattened_assembly
+
         # FemtetInterface の設定 (femprj_path, model_name の更新など)
         # + restore 情報の上書き
         super().__init__(
             prt_path=self.prt_path,
+            export_curves=self.export_curves,
+            export_surfaces=self.export_surfaces,
+            export_solids=self.export_solids,
+            export_flattened_assembly=self.export_flattened_assembly,
             **kwargs
         )
 
@@ -86,10 +102,27 @@ class FemtetWithNXInterface(FemtetInterface):
             tmp_dict[row['name']] = row['value']
         str_json = json.dumps(tmp_dict)
 
+        # create dumped json of export settings
+        tmp_dict = dict(
+            include_curves=self.export_curves,
+            include_surfaces=self.export_surfaces,
+            include_solids=self.export_solids,
+            flatten_assembly=self.export_flattened_assembly,
+        )
+        dumped_json_export_settings = 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],
+            [
+                self.run_journal_path,  # run_journal.exe
+                self._JOURNAL_PATH,  # update_model.py
+                '-args',
+                self.prt_path,
+                str_json,
+                x_t_path,
+                dumped_json_export_settings,
+            ],
             env=env,
             shell=True,
             cwd=os.path.dirname(self.prt_path)

pyfemtet/opt/interface/_femtet_with_nx/update_model.py

@@ -1,35 +1,34 @@
 import os
 import sys
 import json
-import NXOpen
-
+from xml.etree.ElementInclude import include
 
-def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
-    '''
-    .prt ファイルのパスを受け取り、parameters に指定された変数を更新し、
-    x_tPath が None のときは.prt と同じディレクトリに
-    .x_t ファイルをエクスポートする
+import NXOpen
 
-    Parameters
-    ----------
-    prtPath : str
-        DESCRIPTION.
-    parameters : 'dict as str'
-        DESCRIPTION.
 
-    Returns
-    -------
-    None.
+def main(
+        prtPath: str,
+        parameters: str,  # dumped json
+        x_tPath: str,
+        dumped_json_export_settings: str,
+):
+    """Update the parameter of .prt file and export to .x_t file."""
 
-    '''    
     # 保存先の設定
-    prtPath = os.path.abspath(prtPath) # 一応
+    prtPath = os.path.abspath(prtPath)
     if x_tPath is None:
         x_tPath = os.path.splitext(prtPath)[0] + '.x_t'
 
     # 辞書の作成
     parameters = json.loads(parameters)
-    
+
+    # export 設定
+    settings = json.loads(dumped_json_export_settings)
+    include_curves = settings['include_curves']
+    include_surfaces = settings['include_surfaces']
+    include_solids = settings['include_solids']
+    flatten_assembly = settings['flatten_assembly']
+
     # session の取得とパートを開く
     theSession = NXOpen.Session.GetSession()
     theSession.Parts.OpenActiveDisplay(prtPath, NXOpen.DisplayPartOption.AllowAdditional)
@@ -40,7 +39,6 @@ def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
     displayPart = theSession.Parts.Display
 
     # 式を更新
-    unit_mm = workPart.UnitCollection.FindObject("MilliMeter")
     for k, v in parameters.items():
         try:
             exp = workPart.Expressions.FindObject(k)
@@ -48,14 +46,15 @@ def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
             print(f'├ 変数{k}は .prt ファイルに含まれていません。無視されます。')
             continue
 
-        workPart.Expressions.EditWithUnits(exp, unit_mm, str(v))
+        workPart.Expressions.Edit(exp, str(v))
         # 式の更新を適用
         id1 = theSession.NewestVisibleUndoMark
         try:
             nErrs1 = theSession.UpdateManager.DoUpdate(id1)
         # 更新に失敗
         except NXOpen.NXException as e:
-            print('└ 形状が破綻しました。操作を取り消します。')
+            print(f'├ ERROR! {e}')
+            print(f'└ 形状が破綻しました。操作を取り消します。')
             return None
 
     print('│ model 更新に成功しました。')
@@ -64,19 +63,28 @@ def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
         # parasolid のエクスポート
         parasolidExporter1 = theSession.DexManager.CreateParasolidExporter()
 
-        parasolidExporter1.ObjectTypes.Curves = False
-        parasolidExporter1.ObjectTypes.Surfaces = False
-        parasolidExporter1.ObjectTypes.Solids = True
+        if include_curves is not None:
+            parasolidExporter1.ObjectTypes.Curves = include_curves
+
+        if include_surfaces is not None:
+            parasolidExporter1.ObjectTypes.Surfaces = include_surfaces
+
+        if include_solids is not None:
+            parasolidExporter1.ObjectTypes.Solids = include_solids
+
+        if flatten_assembly is not None:
+            parasolidExporter1.FlattenAssembly = flatten_assembly
 
         parasolidExporter1.InputFile = prtPath
         parasolidExporter1.ParasolidVersion = NXOpen.ParasolidExporter.ParasolidVersionOption.Current
         parasolidExporter1.OutputFile = x_tPath
 
         parasolidExporter1.Commit()
-
         parasolidExporter1.Destroy()
-    except:
-        print('└ parasolid 更新に失敗しました。')
+
+    except Exception as e:
+        print(f'├ ERROR! {e}')
+        print(f'└ parasolid 更新に失敗しました。')
         return None
 
     print('└ parasolid 更新が正常に終了しました。')

pyfemtet/opt/opt/_base.py

@@ -88,6 +88,8 @@ class AbstractOptimizer(ABC):
             y,
             c,
             self.message,
+            postprocess_func=self.fem.postprocess_func,
+            postprocess_args=self.fem.create_postprocess_args(),
         )
 
         logger.debug('history.record end')

pyfemtet/opt/visualization/_graphs.py

@@ -2,9 +2,6 @@ import plotly.graph_objs as go
 import plotly.express as px
 
 
-_CUSTOM_DATA_DICT = {'trial': 0}  # 連番
-
-
 class _ColorSet:
     non_domi = {True: '#007bff', False: '#6c757d'}  # color
 
@@ -49,7 +46,7 @@ def update_hypervolume_plot(history, df):
         x="trial",
         y="hypervolume",
         markers=True,
-        custom_data=_CUSTOM_DATA_DICT.keys(),
+        custom_data=['trial'],
     )
 
     fig.update_layout(
@@ -67,13 +64,17 @@ def update_default_figure(history, df):
     obj_names = history.obj_names
 
     if len(obj_names) == 0:
-        return go.Figure()
+        fig = go.Figure()
 
     elif len(obj_names) == 1:
-        return update_single_objective_plot(history, df)
+        fig = update_single_objective_plot(history, df)
 
     elif len(obj_names) >= 2:
-        return update_multi_objective_pairplot(history, df)
+        fig = update_multi_objective_pairplot(history, df)
+
+    fig.update_traces(hoverinfo="none", hovertemplate=None)
+
+    return fig
 
 
 def update_single_objective_plot(history, df):
@@ -81,6 +82,9 @@ def update_single_objective_plot(history, df):
     df = _ls.localize(df)
     obj_name = history.obj_names[0]
 
+    df.columns = [c.replace(' / ', '<BR>/ ') for c in df.columns]
+    obj_name = obj_name.replace(' / ', '<BR>/ ')
+
     fig = px.scatter(
         df,
         x='trial',
@@ -94,7 +98,7 @@ def update_single_objective_plot(history, df):
             _ls.feasible['label']: False,
             'trial': True,
         },
-        custom_data=_CUSTOM_DATA_DICT.keys(),
+        custom_data=['trial'],
     )
 
     fig.add_trace(
@@ -126,6 +130,9 @@ def update_multi_objective_pairplot(history, df):
 
     obj_names = history.obj_names
 
+    df.columns = [c.replace(' / ', '<BR>/ ') for c in df.columns]
+    obj_names = [o.replace(' / ', '<BR>/ ') for o in obj_names]
+
     common_kwargs = dict(
         color=_ls.non_domi['label'],
         color_discrete_map={
@@ -137,11 +144,7 @@ def update_multi_objective_pairplot(history, df):
             _ls.feasible[True]: _ss.feasible[True],
             _ls.feasible[False]: _ss.feasible[False],
         },
-        hover_data={
-            _ls.feasible['label']: False,
-            'trial': True,
-        },
-        custom_data=_CUSTOM_DATA_DICT.keys(),
+        custom_data=['trial'],
         category_orders={
             _ls.feasible['label']: (_ls.feasible[False], _ls.feasible[True]),
             _ls.non_domi['label']: (_ls.non_domi[False], _ls.non_domi[True]),