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

pyfemtet/FemtetPJTSample/NX_ex01/NX_ex01.py

@@ -1,17 +1,20 @@
-"""外部 CAD ソフト NX との連携
+"""External CAD (NX) Integration
 
-外部 CAD ソフト NX で作成したパラメトリックモデルを
-Femtet にインポートして最適化を行います。
+This script performs parametric optimization
+using a project that has imported an external CAD model
+that has been parametrically modeled.
 
-事前準備として、以下の作業を行ってください。
-    - NX_ex01.prt と NX_ex01.femprj を同じフォルダに配置する
-    - C:\temp フォルダを作成する
-        ※ 最適化の実行中に NX から .x_t ファイルがエクスポートされます。
+Please perform the following steps in preparation.
+    - Install NX.
+    - Place NX_ex01.prt, NX_ex01.femprj and .py file in the same folder.
+    - Create C:\\temp folder on your disk.
+        Note: NX exports .x_t files during optimization.
 """
 
 import os
 from pyfemtet.opt import FEMOpt, OptunaOptimizer
 from pyfemtet.opt.interface import FemtetWithNXInterface
+from pyfemtet.core import ModelError
 
 
 here, me = os.path.split(__file__)
@@ -19,35 +22,60 @@ os.chdir(here)
 
 
 def disp(Femtet):
-    """解析結果から Z 方向最大変位を取得します。
-    目的関数の第一引数は Femtet インスタンスである必要があります。
+    """Obtain the maximum displacement in the Z direction from the analysis results.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum displacement is always negative.
+        If the maximum displacement is positive,
+        it is assumed that boundary condition assignment has failed
+        and a ModelError is raised.
+        
+        If a ModelError, MeshError, or SolveError is raised during an optimization,
+        the Optimizer considers the trial a failure
+        and skips it to the next trial.
     """
     _, _, ret = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+
+    if ret >= 0:
+        raise ModelError('The boundary condition assignment is incorrect.')
     return ret
 
 
 def volume(Femtet):
-    """解析結果からモデル体積を取得します。
-    目的関数の第一引数は Femtet インスタンスである必要があります。
-    """
+    """Obtain the volume."""
     _, ret = Femtet.Gogh.CalcVolume_py([0])
     return ret
 
 
 def C_minus_B(_, opt):
-    """C 寸法と B 寸法の差を計算します。
+    """Calculate the difference between C and B dimensions.
 
-    拘束関数の第一引数は Femtet インスタンスである必要がありますが、
-    この例では使用していません。
+    The constraint function must take a Femtet instance as its first argument,
+    but this example does not use it.
 
-    ほかの例では設計変数にアクセスする際以下のスニペットを用いますが、
-    CAD 連携を行う場合、Femtet に設計変数が設定されていないためです。
-        A = Femtet.GetVariableValue('A')
-
-    pyfemtet.opt では目的関数・拘束関数の第二引数以降に任意の変数を設定できます。
-    この例では、第二引数に FEMOpt のメンバー変数 opt を取り、
-    そのメソッド get_parameter() を用いて設計変数を取得しています。
+    Another example uses the following snippet to access design variables:
 
+        A = Femtet.GetVariableValue('A')
+    
+    However, when performing CAD integration,
+    this method does not work because the variables are not set in the .femprj file.
+
+    In CAD integration, design variables are obtained in the following way.
+    
+    The objective function and constraint function can take any variable after the first argument.
+    The member variable opt of FEMOpt has a method called get_parameter().
+    This method can retrieve design variables added by add_parameter().
+    By taking opt as the second argument, you can execute get_parameter()
+    in the objective function or constraint function to obtain the design variables.
+    
     """
     A, B, C = opt.get_parameter('values')
     return C - B
@@ -55,35 +83,36 @@ def C_minus_B(_, opt):
 
 if __name__ == '__main__':
 
-    # NX-Femtet 連携オブジェクトを用意
-    # ここで起動している Femtet と紐づけがされます。
+    # Define NX-Femtet integration object.
+    # At this point, Python is connected to the running Femtet.
     fem = FemtetWithNXInterface(
         prt_path='NX_ex01.prt',
         femprj_path='NX_ex01.femprj',
     )
 
+    # Define mathematical optimization object.
     opt = OptunaOptimizer(
         sampler_kwargs=dict(
             n_startup_trials=5,
         )
     )
 
-    # 最適化処理を行うオブジェクトに連携オブジェクトを紐づけ
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
     femopt = FEMOpt(fem=fem, opt=opt)
 
-    # 設計変数の設定
+    # Add design variables (Use variable names set in NX) to the optimization problem.
     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)
 
-    # 拘束関数の設定
+    # Add constraint to the optimization problem.
     femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
 
-    # 目的関数の設定
-    femopt.add_objective(disp, name='変位', direction=0)
-    femopt.add_objective(volume, name='体積', direction='minimize')
+    # Add objective to the optimization problem.
+    femopt.add_objective(disp, name='displacement', direction=0)
+    femopt.add_objective(volume, name='volume', direction='minimize')
 
-    # 最適化の実行
+    # Run optimization.
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20)
+    femopt.optimize(n_trials=20)
     femopt.terminate_all()

pyfemtet/FemtetPJTSample/Sldworks_ex01/Sldworks_ex01.py

@@ -1,12 +1,14 @@
-"""外部 CAD ソフト Solidworks との連携
+"""External CAD (Solidworks) Integration
 
-外部 CAD ソフト Solidworks で作成したパラメトリックモデルを
-Femtet にインポートして最適化を行います。
+This script performs parametric optimization
+using a project that has imported an external CAD model
+that has been parametrically modeled.
 
-事前準備として、以下の作業を行ってください。
-    - Sldworks_ex01.SLDPRT と Sldworks_ex01.femprj を同じフォルダに配置する
-    - C:\temp フォルダを作成する
-        ※ 最適化の実行中に Solidworks から .x_t ファイルがエクスポートされます。
+Please perform the following steps in preparation.
+    - Install Solidworks.
+    - Place Sldworks_ex01.SLDPRT, Sldworks_ex01.femprj and this .py file in the same folder.
+    - Create C:\\temp folder on your disk.
+        Note: NX exports .x_t files during optimization.
 """
 
 import os
@@ -20,45 +22,60 @@ os.chdir(here)
 
 
 def disp(Femtet):
-    """解析結果から Z 方向最大変位を取得します。
-    目的関数の第一引数は Femtet インスタンスである必要があります。
+    """Obtain the maximum displacement in the Z direction from the analysis results.
+
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum displacement is always negative.
+        If the maximum displacement is positive,
+        it is assumed that boundary condition assignment has failed
+        and a ModelError is raised.
+
+        If a ModelError, MeshError, or SolveError is raised during an optimization,
+        the Optimizer considers the trial a failure
+        and skips it to the next trial.
     """
     _, _, ret = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
 
-    # CAD 連携の場合、境界条件をトポロジーIDに基づいて割り当てているので、
-    # 意図しない箇所に境界条件が割り当てられることがあります。
-    # この問題では意図通りの割り当てができていれば最大変位は必ず負なので
-    # 答えが正の場合は境界条件割り当てに失敗しているとみなして
-    # ModelError を送出するようにします。
-    # 最適化ルーチン中に ModelError, MeshError, SolveError が送出された場合
-    # Optimizer はその試行を失敗とみなし、スキップして次の試行を行います。
     if ret >= 0:
-        raise ModelError('境界条件の割り当てが間違えています。')
+        raise ModelError('The boundary condition assignment is incorrect.')
     return ret
 
 
 def volume(Femtet):
-    """解析結果からモデル体積を取得します。
-    目的関数の第一引数は Femtet インスタンスである必要があります。
-    """
+    """Obtain the volume."""
     _, ret = Femtet.Gogh.CalcVolume_py([0])
     return ret
 
 
 def C_minus_B(_, opt):
-    """C 寸法と B 寸法の差を計算します。
-
-    拘束関数の第一引数は Femtet インスタンスである必要がありますが、
-    この例では使用していません。
+    """Calculate the difference between C and B dimensions.
 
-    ほかの例では設計変数にアクセスする際以下のスニペットを用いますが、
-    CAD 連携を行う場合、Femtet に設計変数が設定されていないためです。
-        A = Femtet.GetVariableValue('A')
+    The constraint function must take a Femtet instance as its first argument,
+    but this example does not use it.
 
-    pyfemtet.opt では目的関数・拘束関数の第二引数以降に任意の変数を設定できます。
-    この例では、第二引数に FEMOpt のメンバー変数 opt を取り、
-    そのメソッド get_parameter() を用いて設計変数を取得しています。
+    Another example uses the following snippet to access design variables:
 
+        A = Femtet.GetVariableValue('A')
+    
+    However, when performing CAD integration,
+    this method does not work because the variables are not set in the .femprj file.
+
+    In CAD integration, design variables are obtained in the following way.
+    
+    The objective function and constraint function can take any variable after the first argument.
+    The member variable opt of FEMOpt has a method called get_parameter().
+    This method can retrieve design variables added by add_parameter().
+    By taking opt as the second argument, you can execute get_parameter()
+    in the objective function or constraint function to obtain the design variables.
+    
     """
     A, B, C = opt.get_parameter('values')
     return C - B
@@ -66,34 +83,39 @@ def C_minus_B(_, opt):
 
 if __name__ == '__main__':
 
-    # Solidworks-Femtet 連携オブジェクトを用意
-    # ここで起動している Femtet と紐づけがされます。
+    # Define Solidworks-Femtet integration object.
+    # At this point, Python is connected to the running Femtet.
     fem = FemtetWithSolidworksInterface(
         sldprt_path='Sldworks_ex01.SLDPRT',
         femprj_path='Sldworks_ex01.femprj',
     )
 
+    # Define mathematical optimization object.
     opt = OptunaOptimizer(
         sampler_kwargs=dict(
             n_startup_trials=5,
         )
     )
 
-    # 最適化処理を行うオブジェクトに連携オブジェクトを紐づけ
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
     femopt = FEMOpt(fem=fem, opt=opt)
 
-    # 設計変数の設定
+    # Add design variables (Use variable names set in NX) to the optimization problem.
     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)
 
-    # 拘束関数の設定
+    # Add constraint to the optimization problem.
+    # Note that we use the ``args`` keyword
+    # to pass femopt.opt as an argument
+    # to the constraint function ``C_minus_B``.
     femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
 
-    # 目的関数の設定
-    femopt.add_objective(disp, name='変位', direction=0)
-    femopt.add_objective(volume, name='体積', direction='minimize')
+    # Add objective to the optimization problem.
+    femopt.add_objective(disp, name='displacement', direction=0)
+    femopt.add_objective(volume, name='volume', direction='minimize')
 
-    # 最適化の実行
+    # Run optimization.
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet/FemtetPJTSample/gau_ex08_parametric.py

@@ -1,26 +1,30 @@
-"""有限長ソレノイドコイルの自己インダクタンス
+"""Single-objective optimization: self-inductance of a finite length solenoid coil
 
-gau_ex08_parametric.femprj に対し磁場解析を行い、
-自己インダクタンスを特定の値にする
-有限長さソレノイドコイルの寸法を探索します。
+Perform magnetic field analysis on gau_ex08_parametric.femprj
+to find the dimensions of a finite length solenoid coil
+that makes the self-inductance a specific value.
 """
 from optuna.integration.botorch import BoTorchSampler
 from pyfemtet.opt import FEMOpt, OptunaOptimizer
 
 
 def inductance(Femtet):
-    """Femtet の解析結果から自己インダクタンスを取得します。
+    """Get the self-inductance.
 
-    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
-        目的関数は第一引数に Femtet インスタンスを取る必要があります。
+    Note:
+        The objective or constraint function
+        must take a Femtet as its first argument
+        and must return a single float.
 
-    l : 計算された自己インダクタンスです。
-        目的関数は単一の float を返す必要があります。
+    Params:
+        Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
 
+    Returns:
+        float: Self-inductance.
     """
     Gogh = Femtet.Gogh
 
-    # インダクタンスの取得
+    # Get inductance.
     cName = Gogh.Gauss.GetCoilList()[0]
     l = Gogh.Gauss.GetL(cName, cName)
     return l  # F
@@ -28,7 +32,7 @@ def inductance(Femtet):
 
 if __name__ == '__main__':
 
-    # 最適化手法を定義するオブジェクトを用意
+    # Define mathematical optimization object.
     opt = OptunaOptimizer(
         sampler_class=BoTorchSampler,
         sampler_kwargs=dict(
@@ -36,20 +40,19 @@ if __name__ == '__main__':
         )
     )
 
-    # 最適化処理を行うオブジェクトを用意
-    femopt = FEMOpt(opt=opt)  # ここで起動している Femtet が紐づけされます
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(opt=opt)
 
-    # 設計変数の登録
-    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='コイル巻き数')
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter("h", 3, lower_bound=1.5, upper_bound=6)
+    femopt.add_parameter("r", 5, lower_bound=1, upper_bound=10)
+    femopt.add_parameter("n", 3, lower_bound=1, upper_bound=5)
 
-    # インダクタンスが 0.1 uF に近づくようにゴールを設定
-    femopt.add_objective(
-        inductance, name='自己インダクタンス', direction=0.1e-06
-        )
+    # Add objective to the optimization problem.
+    # The target inductance value is 0.1 uF.
+    femopt.add_objective(inductance, name='self-inductance', direction=0.1e-06)
 
-    # 最適化の実行
+    # Run optimization.
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20)
+    femopt.optimize(n_trials=20)
     femopt.terminate_all()

pyfemtet/FemtetPJTSample/her_ex40_parametric.py

@@ -1,3 +1,9 @@
+"""Single-objective optimization: Resonant frequency of a circular patch antenna
+
+Using Femtet’s electromagnetic wave analysis solver,
+we explain an example of setting the resonant frequency
+of a circular patch antenna to a specific value.
+"""
 from time import sleep
 
 import numpy as np
@@ -8,9 +14,8 @@ from optuna.integration.botorch import BoTorchSampler
 from pyfemtet.opt import OptunaOptimizer, FEMOpt
 
 
-
 class SParameterCalculator:
-    """S パラメータ・共振周波数計算用クラスです。"""
+    """This class is for calculating S-parameters and resonance frequencies."""
     
     def __init__(self):
         self.freq = []
@@ -20,51 +25,55 @@ class SParameterCalculator:
         self.minimum_S = None
 
     def get_result_from_Femtet(self, Femtet):
-        """Femtet の解析結果から周波数と S パラメータの関係を取得します。"""
+        """Obtain the relationship between frequency and S-parameter from the Femtet analysis results."""
 
-        # 前準備
+        # Preparation
         Femtet.OpenCurrentResult(True)
         Gogh = Femtet.Gogh
         
-        # 各モードに対して周波数と S(1,1) を取得する
+        # Obtain the frequency and S(1,1) for each mode
         mode = 0
         freq_list = []
         dB_S_list = []
-        for mode in tqdm(range(Gogh.Hertz.nMode), '結果取得中'):
-            # Femtet 結果画面のモード設定
+        for mode in tqdm(range(Gogh.Hertz.nMode), 'Obtaining frequency and S-parameter'):
+            # Femtet result screen mode settings
             Gogh.Hertz.Mode = mode
             sleep(0.01)
-            # 周波数の取得
+            # Get frequency
             freq = Gogh.Hertz.GetFreq().Real
-            # S パラメータの取得
+            # Get S-parameters
             comp_S = Gogh.Hertz.GetSMatrix(0, 0)
             norm = np.linalg.norm((comp_S.Real, comp_S.Imag))
             dB_S = 20 * np.log10(norm)
-            # 結果の取得
+            # Get results
             freq_list.append(freq)
             dB_S_list.append(dB_S)
         self.freq = freq_list
         self.S = dB_S_list
 
     def calc_resonance_frequency(self):
-        """S に対して最初のピークを与える freq を計算します。"""
+        """Compute the frequency that gives the first peak for S-parameter."""
         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.core import SolveError
         if len(peaks) == 0:
-            raise SolveError('ピークが検出されませんでした。')
+            raise SolveError('No peaks detected.')
         self.resonance_frequency = self.freq[peaks[0]]
         self.minimum_S = self.S[peaks[0]]
 
     def get_resonance_frequency(self, Femtet):
-        """共振周波数を計算します。
+        """Calculate the resonant frequency.
 
-        Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
-            目的関数は第一引数に Femtet インスタンスを取る必要があります。
-
-        f : 計算された共振周波数です。
-            目的関数は単一の float を返す必要があります。
+        Note:
+            The objective or constraint function
+            must take a Femtet as its first argument
+            and must return a single float.
 
+        Params:
+            Femtet: An instance for using Femtet macros. For more information, see "Femtet Macro Help / CFemtet Class".
+        
+        Returns:
+            float: A resonance frequency.
         """
         self.get_result_from_Femtet(Femtet)
         self.calc_resonance_frequency()
@@ -73,14 +82,16 @@ class SParameterCalculator:
         
 
 def antenna_is_smaller_than_substrate(Femtet):
-    """アンテナのサイズと基板のサイズの関係を計算します。
+    """Calculate the relationship between antenna size and board size.
 
-    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
-        拘束関数は第一引数に Femtet インスタンスを取る必要があります。
-
-    Sx/2 - ant_r : 基板サイズとアンテナサイズの差です。
-        拘束関数は単一の float を返す必要があります。
+    This function is used to constrain the model
+    from breaking down while changing parameters.
 
+    Params:
+        Femtet: An instance for using Femtet macros.
+    
+    Returns:
+        float: Difference between the board size and antenna size. Must be equal to or grater than 1 mm.
     """
     ant_r = Femtet.GetVariableValue('ant_r')
     Sx = Femtet.GetVariableValue('sx')
@@ -88,14 +99,16 @@ def antenna_is_smaller_than_substrate(Femtet):
 
 
 def port_is_inside_antenna(Femtet):
-    """給電ポートの位置とアンテナのサイズの関係を計算します。
+    """Calculate the relationship between the feed port location and antenna size.
 
-    Femtet : マクロを使用するためのインスタンスです。詳しくは "Femtet マクロヘルプ / CFemtet クラス" をご覧ください。
-        拘束関数は第一引数に Femtet インスタンスを取る必要があります。
-
-    ant_r - xf : アンテナ辺縁と給電ポートの位置の差です。
-        拘束関数は単一の float を返す必要があります。
+    This function is used to constrain the model
+    from breaking down while changing parameters.
 
+    Params:
+        Femtet: An instance for using Femtet macros.
+    
+    Returns:
+        float: Difference between the antenna edge and the position of the feed port. Must be equal to or grater than 1 mm.
     """
     ant_r = Femtet.GetVariableValue('ant_r')
     xf = Femtet.GetVariableValue('xf')
@@ -103,10 +116,10 @@ def port_is_inside_antenna(Femtet):
 
 
 if __name__ == '__main__':
-    # S パラメータ計算用クラス
+    # Define the object for calculating S-parameters and resonance frequencies.
     s = SParameterCalculator()
 
-    # 最適化手法を定義するオブジェクトを用意
+    # Define mathematical optimization object.
     opt = OptunaOptimizer(
         sampler_class=BoTorchSampler,
         sampler_kwargs=dict(
@@ -114,23 +127,22 @@ if __name__ == '__main__':
         )
     )
     
-    # 最適化処理を行うオブジェクトを用意
-    femopt = FEMOpt(
-        opt=opt,
-    )  # ここで起動している Femtet が紐づけされます
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(opt=opt)
     
-    # 設計変数の設定
-    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='給電ポートの偏心量')
+    # Add design variables (Use variable names set in Femtet) to the optimization problem.
+    femopt.add_parameter('ant_r', 10, 5, 20)
+    femopt.add_parameter('sx', 50, 40, 60)
+    femopt.add_parameter('xf', 5, 1, 20)
 
-    # 拘束の設定
-    femopt.add_constraint(antenna_is_smaller_than_substrate, 'アンテナサイズ', lower_bound=1)
-    femopt.add_constraint(port_is_inside_antenna, 'ポート位置', lower_bound=1)
+    # Add constraint to the optimization problem.
+    femopt.add_constraint(antenna_is_smaller_than_substrate, 'board_antenna_clearance', lower_bound=1)
+    femopt.add_constraint(port_is_inside_antenna, 'antenna_port_clearance', lower_bound=1)
 
-    # 目的の設定
-    femopt.add_objective(s.get_resonance_frequency, '第一共振周波数（GHz）', direction=3.0)
+    # Add objective to the optimization problem.
+    # The target frequency is 3 GHz.
+    femopt.add_objective(s.get_resonance_frequency, 'First_resonant_frequency(GHz)', direction=3.0)
 
     femopt.set_random_seed(42)
-    femopt.main(n_trials=20)
+    femopt.optimize(n_trials=20)
     femopt.terminate_all()