pyfemtet 0.1.12__py3-none-any.whl → 0.2.1__py3-none-any.whl

pyfemtet/FemtetPJTSample/NX_ex01/NX_ex01.py

@@ -1,44 +1,81 @@
-import numpy as np
+"""外部 CAD ソフト NX との連携
 
-from PyFemtet.opt._NX_Femtet import NX_Femtet
-from PyFemtet.opt import FemtetOptuna
+外部 CAD ソフト NX で作成したパラメトリックモデルを
+Femtet にインポートして最適化を行います。
 
-from win32com.client import constants
-from win32com.client import Dispatch
+事前準備として、以下の作業を行ってください。
+    - NX_ex01.prt と NX_ex01.femprj を同じフォルダに配置する
+    - C:\temp フォルダを作成する
+        ※ 最適化の実行中に NX から .x_t ファイルがエクスポートされます。
+"""
 
 import os
+from pyfemtet.opt import FemtetWithNXInterface, OptimizerOptuna
+
+
+here, me = os.path.split(__file__)
+os.chdir(here)
+
 
 def disp(Femtet):
-    '''評価指標を定義する関数は、第一引数に Femtet のインスタンスを取るようにしてください。'''
-    # Femtet = Dispatch('FemtetMacro.Femtet')
-    # Femtet.OpenCurrentResult(True)
-    Gogh = Femtet.Gogh
-    _, _, ret = Gogh.Galileo.GetMaxDisplacement_py()
+    """解析結果から Z 方向最大変位を取得します。
+    目的関数の第一引数は Femtet インスタンスである必要があります。
+    """
+    _, _, ret = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
     return ret
 
+
 def volume(Femtet):
-    '''評価指標を定義する関数は、第一引数に Femtet のインスタンスを取るようにしてください。'''
-    Gogh = Femtet.Gogh
-    _, ret = Gogh.CalcVolume_py([0])
+    """解析結果からモデル体積を取得します。
+    目的関数の第一引数は Femtet インスタンスである必要があります。
+    """
+    _, ret = Femtet.Gogh.CalcVolume_py([0])
     return ret
 
 
-if __name__=='__main__':
-    here, me = os.path.split(__file__)
-    os.chdir(here)
-    FEM = NX_Femtet('NX_ex01.prt') # この機能を使う際はエントリポイントをガードしてください。
-    FEMOpt = FemtetOptuna(FEM)
-    FEMOpt.add_parameter('A_x', 50, lower_bound=25, upper_bound=95)
-    FEMOpt.add_parameter('A_y', 45, lower_bound=5, upper_bound=45)
-    FEMOpt.add_parameter('B_x', 30, lower_bound=25, upper_bound=95)
-    FEMOpt.add_parameter('B_y', 12, lower_bound=5, upper_bound=45)
-    FEMOpt.add_parameter('C_x', 90, lower_bound=25, upper_bound=95)
-    FEMOpt.add_parameter('C_y', 45, lower_bound=5, upper_bound=45)
-    FEMOpt.add_parameter('Cut_x', 10, lower_bound=5, upper_bound=45)
-    FEMOpt.add_parameter('Cut_y', 20, lower_bound=5, upper_bound=45)
-    FEMOpt.add_objective(disp, direction=0)
-    FEMOpt.add_objective(volume, direction='minimize')
-
-    FEMOpt.set_process_monitor()
-    FEMOpt.main()
-    
+def C_minus_B(_, femopt):
+    """C 寸法と B 寸法の差を計算します。
+
+    拘束関数の第一引数は Femtet インスタンスである必要がありますが、
+    この例では使用していません。
+
+    ほかの例では設計変数にアクセスする際以下のスニペットを用いますが、
+    CAD 連携を行う場合、Femtet に設計変数が設定されていないためです。
+        A = Femtet.GetVariableValue('A')
+
+    pyfemtet.opt では目的関数・拘束関数の第二引数以降に任意の変数を設定できます。
+    この例では、第二引数に OptimizerOptuna クラスのオブジェクトを取り、
+    そのメソッド get_parameter() を用いて設計変数を取得しています。
+
+    """
+    A, B, C = femopt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # NX-Femtet 連携オブジェクトを用意
+    # ここで起動している Femtet と紐づけがされます。
+    fem = FemtetWithNXInterface(
+        prt_path='NX_ex01.prt',
+        femprj_path='NX_ex01.femprj',
+    )
+
+    # 最適化処理を行うオブジェクトに連携オブジェクトを紐づけ
+    femopt = OptimizerOptuna(fem)
+
+    # 設計変数の設定
+    femopt.add_parameter('A', 10, lower_bound=1, upper_bound=59)
+    femopt.add_parameter('B', 10, lower_bound=1, upper_bound=40)
+    femopt.add_parameter('C', 20, lower_bound=5, upper_bound=59)
+
+    # 拘束関数の設定
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt)
+
+    # 目的関数の設定
+    femopt.add_objective(disp, name='変位', direction=0)
+    femopt.add_objective(volume, name='体積', direction='minimize')
+
+    # 最適化の実行
+    femopt.set_random_seed(42)
+    femopt.main(n_trials=20, use_lhs_init=False)

pyfemtet/FemtetPJTSample/gau_ex08_parametric.py

@@ -1,34 +1,46 @@
-from PyFemtet.opt import FemtetScipy
+"""有限長ソレノイドコイルの自己インダクタンス
 
-def L(Femtet):
-    # L の取得
+gau_ex08_parametric.femprj に対し磁場解析を行い、
+自己インダクタンスを特定の値にする
+有限長さソレノイドコイルの寸法を探索します。
+"""
+
+from pyfemtet.opt import OptimizerOptuna
+
+
+def inductance(Femtet):
+    """Femtet の解析結果から自己インダクタンスを取得します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    l : 計算された自己インダクタンスです。
+        目的関数は単一の float を返す必要があります。
+
+    """
     Gogh = Femtet.Gogh
-    # コイル名の取得
-    cName = Gogh.Gauss.GetCoilList()[0]
-    # インダクタンスの取得
-    return Gogh.Gauss.GetL(cName, cName)
 
+    # インダクタンスの取得
+    cName = Gogh.Gauss.GetCoilList()[0]
+    l = Gogh.Gauss.GetL(cName, cName)
+    return l  # F
 
-# 最適化処理を行うオブジェクトを用意
-FEMOpt = FemtetScipy()
 
-# 解析モデルで登録された変数
-FEMOpt.add_parameter("h", 3, 1.5, memo='1巻きピッチ')
-FEMOpt.add_parameter("r", 5, 3, memo='コイル半径')
-FEMOpt.add_parameter("n", 5, 1, 20, memo='コイル半径')
+if __name__ == '__main__':
 
-# インダクタンスが 0.44 uF に近づくようにゴールを設定する
-FEMOpt.add_objective(
-    L,
-    name='自己インダクタンス',
-    direction=4.4e-07
-    )
+    # 最適化処理を行うオブジェクトを用意
+    femopt = OptimizerOptuna()  # ここで起動している Femtet が紐づけされます
 
-# 最適化実行中にその収束状況を表示する(experimental)
-FEMOpt.set_process_monitor()
+    # 設計変数の登録
+    femopt.add_parameter("h", 3, lower_bound=1.5, upper_bound=6, memo='1巻きピッチ')
+    femopt.add_parameter("r", 5, lower_bound=1, upper_bound=10, memo='コイル半径')
+    femopt.add_parameter("n", 3, lower_bound=1, upper_bound=5, memo='コイル巻き数')
 
-# 最適化の実行 ※実行すると、csv ファイルでの最適化過程の保存が始まります。
-FEMOpt.main()
+    # インダクタンスが 0.44 uF に近づくようにゴールを設定
+    femopt.add_objective(
+        inductance, name='自己インダクタンス', direction=0.1e-06
+        )
 
-# 最適化過程の一覧表示（最適化終了時点での csv ファイルの内容と同じです）
-print(FEMOpt.history)
+    # 最適化の実行
+    femopt.set_random_seed(42)
+    femopt.main(n_trials=20, method='botorch', use_lhs_init=False)

pyfemtet/FemtetPJTSample/her_ex40_parametric.py

@@ -4,15 +4,12 @@ import numpy as np
 from scipy.signal import find_peaks
 from tqdm import tqdm
 
-from pythoncom import com_error
+from pyfemtet.opt import OptimizerOptuna
 
-from PyFemtet.opt import FemtetOptuna
 
-from win32com.client import Dispatch
-from win32com.client import constants
 
-# S パラメータ・共振周波数計算用クラス
 class SParameterCalculator:
+    """S パラメータ・共振周波数計算用クラスです。"""
     
     def __init__(self):
         self.freq = []
@@ -22,6 +19,8 @@ class SParameterCalculator:
         self.minimum_S = None
 
     def get_result_from_Femtet(self, Femtet):
+        """Femtet の解析結果から周波数と S パラメータの関係を取得します。"""
+
         # 前準備
         Femtet.OpenCurrentResult(True)
         Gogh = Femtet.Gogh
@@ -33,7 +32,7 @@ class SParameterCalculator:
         for mode in tqdm(range(Gogh.Hertz.nMode), '結果取得中'):
             # Femtet 結果画面のモード設定
             Gogh.Hertz.Mode = mode
-            sleep(0.1) # mode 変更が反映されるまでの猶予時間
+            sleep(0.01)
             # 周波数の取得
             freq = Gogh.Hertz.GetFreq().Real
             # S パラメータの取得
@@ -47,56 +46,79 @@ class SParameterCalculator:
         self.S = dB_S_list
 
     def calc_resonance_frequency(self):
-        # S に対して最初のピークを与える freq を計算
+        """S に対して最初のピークを与える freq を計算します。"""
         x = -np.array(self.S)
         peaks, _ = find_peaks(x, height=None, threshold=None, distance=None, prominence=0.5, width=None, wlen=None, rel_height=0.5, plateau_size=None)
-        from PyFemtet.opt.core import SolveError
+        from pyfemtet.opt.core import SolveError
         if len(peaks)==0:
             raise SolveError('ピークが検出されませんでした。')
         self.resonance_frequency = self.freq[peaks[0]]
         self.minimum_S = self.S[peaks[0]]
 
     def get_resonance_frequency(self, Femtet):
+        """共振周波数を計算します。
+
+        Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+            目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+        f : 計算された共振周波数です。
+            目的関数は単一の float を返す必要があります。
+
+        """
         self.get_result_from_Femtet(Femtet)
         self.calc_resonance_frequency()
-        return self.resonance_frequency * 1e-9
+        f = self.resonance_frequency * 1e-9
+        return f  # GHz
         
 
-# サイズ拘束用関数
 def anntena_is_smaller_than_substrate(Femtet):
+    """アンテナのサイズと基板のサイズの関係を計算します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        拘束関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    Sx/2 - ant_r : 基板サイズとアンテナサイズの差です。
+        拘束関数は単一の float を返す必要があります。
+
+    """
     ant_r = Femtet.GetVariableValue('ant_r')
     Sx = Femtet.GetVariableValue('sx')
-    return Sx/2 - ant_r # 1 以上になるようにする
+    return Sx/2 - ant_r
+
 
 def port_is_inside_anntena(Femtet):
+    """給電ポートの位置とアンテナのサイズの関係を計算します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        拘束関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    ant_r - xf : アンテナ辺縁と給電ポートの位置の差です。
+        拘束関数は単一の float を返す必要があります。
+
+    """
     ant_r = Femtet.GetVariableValue('ant_r')
     xf = Femtet.GetVariableValue('xf')
-    return ant_r - xf # 1 以上になるようにする
-    
-def size(Femtet):
-    Sx = Femtet.GetVariableValue('sx')
-    return Sx**2
-    
+    return ant_r - xf
+
+
 if __name__=='__main__':
     # S パラメータ計算用クラス
     s = SParameterCalculator()
     
-    # 最適化連携クラス
-    FEMOpt = FemtetOptuna() # ここで起動している Femtet が紐づけされます
-    
-    # 最適化の設定
-    FEMOpt.add_parameter('ant_r', 10, 5, 100, memo='円形アンテナの半径')
-    FEMOpt.add_parameter('sx', 50, 5, 100, memo='基板のサイズ')
-    FEMOpt.add_parameter('xf', 5, 1, 100, memo='給電ポートの偏心量')
-    FEMOpt.add_constraint(anntena_is_smaller_than_substrate, lower_bound=1)
-    FEMOpt.add_constraint(port_is_inside_anntena, lower_bound=1)
-    FEMOpt.add_objective(s.get_resonance_frequency, '第一共振周波数（GHz）', direction=3.5)
-    FEMOpt.add_objective(size, '基板サイズ（mm2）')
-    
-    FEMOpt.set_process_monitor()
-    
-    FEMOpt.main()
-    
-    import matplotlib.pyplot as plt
-    plt.show()
+    # 最適化処理を行うオブジェクトを用意
+    femopt = OptimizerOptuna()  # ここで起動している Femtet が紐づけされます
     
+    # 設計変数の設定
+    femopt.add_parameter('ant_r', 10, 5, 20, memo='円形アンテナの半径')
+    femopt.add_parameter('sx', 50, 40, 60, memo='基板のサイズ')
+    femopt.add_parameter('xf', 5, 1, 20, memo='給電ポートの偏心量')
+
+    # 拘束の設定
+    femopt.add_constraint(anntena_is_smaller_than_substrate, 'アンテナサイズ', lower_bound=1)
+    femopt.add_constraint(port_is_inside_anntena, 'ポート位置', lower_bound=1)
+
+    # 目的の設定
+    femopt.add_objective(s.get_resonance_frequency, '第一共振周波数（GHz）', direction=3.0)
+
+    femopt.set_random_seed(42)
+    femopt.main(method='botorch', n_trials=20)

pyfemtet/FemtetPJTSample/wat_ex14_parallel_parametric.py

@@ -0,0 +1,62 @@
+"""基板上の発熱体
+
+wat_ex14_parametric.femprj に対し熱伝導解析を行い、
+チップの発熱による温度上昇を最小にしつつ
+基板寸法を最小にする
+基板寸法・チップ配置寸法を探索します。
+"""
+
+from pyfemtet.opt import OptimizerOptuna
+
+
+def maxtemp(Femtet, body_name):
+    """Femtet の解析結果からチップの最高温度を取得します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    max_temp : 計算された最高温度です。
+        目的関数は単一の float を返す必要があります。
+
+    """
+    Gogh = Femtet.Gogh
+
+    maxtemp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+
+    return maxtemp  # degree
+
+
+def substrate_size(Femtet):
+    """Femtet の設計変数から基板サイズを取得します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    subs_w * subs_d : XY 平面における基板の専有面積です。
+        目的関数は単一の float を返す必要があります。
+
+    """
+    subs_w = Femtet.GetVariableValue('substrate_w')
+    subs_d = Femtet.GetVariableValue('substrate_d')
+
+    return subs_w * subs_d  # mm2
+
+
+if __name__ == '__main__':
+
+    # 最適化処理を行うオブジェクトを用意
+    femopt = OptimizerOptuna()
+
+    # 設計変数の設定
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40, memo='基板サイズ X')
+    femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60, memo='基板サイズ Y')
+
+    # 目的関数の設定
+    femopt.add_objective(maxtemp, name='メインチップ温度', args=('MAINCHIP',))
+    femopt.add_objective(maxtemp, name='サブチップ温度', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='基板サイズ')
+
+    # 最適化の実行
+    femopt.set_random_seed(42)
+    # femopt.main(n_trials=20)
+    femopt.main(n_trials=20, n_parallel=3)  # ここのみ wat_ex14_parametric.py から変更しました。

pyfemtet/FemtetPJTSample/wat_ex14_parametric.py

@@ -0,0 +1,61 @@
+"""基板上の発熱体
+
+wat_ex14_parametric.femprj に対し熱伝導解析を行い、
+チップの発熱による温度上昇を最小にしつつ
+基板寸法を最小にする
+基板寸法・チップ配置寸法を探索します。
+"""
+
+from pyfemtet.opt import OptimizerOptuna
+
+
+def maxtemp(Femtet, body_name):
+    """Femtet の解析結果からチップの最高温度を取得します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    max_temp : 計算された最高温度です。
+        目的関数は単一の float を返す必要があります。
+
+    """
+    Gogh = Femtet.Gogh
+
+    maxtemp, _, _ = Gogh.Watt.GetTemp_py(body_name)
+
+    return maxtemp  # degree
+
+
+def substrate_size(Femtet):
+    """Femtet の設計変数から基板サイズを取得します。
+
+    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
+        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+
+    subs_w * subs_d : XY 平面における基板の専有面積です。
+        目的関数は単一の float を返す必要があります。
+
+    """
+    subs_w = Femtet.GetVariableValue('substrate_w')
+    subs_d = Femtet.GetVariableValue('substrate_d')
+
+    return subs_w * subs_d  # mm2
+
+
+if __name__ == '__main__':
+
+    # 最適化処理を行うオブジェクトを用意
+    femopt = OptimizerOptuna()
+
+    # 設計変数の設定
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40, memo='基板サイズ X')
+    femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60, memo='基板サイズ Y')
+
+    # 目的関数の設定
+    femopt.add_objective(maxtemp, name='メインチップ温度', args=('MAINCHIP',))
+    femopt.add_objective(maxtemp, name='サブチップ温度', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='基板サイズ')
+
+    # 最適化の実行
+    femopt.set_random_seed(42)
+    femopt.main(n_trials=20)

pyfemtet/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.12"
+__version__ = "0.2.1"

pyfemtet/opt/_FemtetWithNX/update_model.py

@@ -42,7 +42,12 @@ def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
     # 式を更新
     unit_mm = workPart.UnitCollection.FindObject("MilliMeter")
     for k, v in parameters.items():
-        exp = workPart.Expressions.FindObject(k)
+        try:
+            exp = workPart.Expressions.FindObject(k)
+        except NXOpen.NXException:
+            print(f'変数{k}は .prt ファイルに含まれていません。無視されます。')
+            continue
+
         workPart.Expressions.EditWithUnits(exp, unit_mm, str(v))
         # 式の更新を適用
         id1 = theSession.NewestVisibleUndoMark
@@ -51,7 +56,6 @@ def main(prtPath:str, parameters:'dict as str', x_tPath:str = None):
         # 更新に失敗
         except NXOpen.NXException as e:
             print('  形状が破綻しました。操作を取り消します。')
-            print('---script end---')
             return
 
 

pyfemtet/opt/__init__.py

@@ -1,4 +1,4 @@
-from ._optuna import OptimizerOptuna
+from .optimizer import OptimizerOptuna
 from .interface import (
     NoFEM,
     FemtetInterface,