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

pyfemtet/opt/femprj_sample/gal_ex58_parametric.py

@@ -0,0 +1,75 @@
+"""Single-objective optimization: bending with consideration for springback.
+
+Using Femtet's stress analysis solver, we will determine the bending angle
+to achieve the desired material bend angle with consideration for springback.
+Elasto-plastic analysis is available in an optional package.
+
+Corresponding project: gal_ex58_parametric.femprj
+"""
+import numpy as np
+from win32com.client import constants
+from optuna.integration.botorch import BoTorchSampler
+
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+
+
+def bending(Femtet):
+    """Get the material bend angle.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Params:
+        Femtet: This is an instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+
+    Returns:
+        float: material bend angle.
+    """
+    Gogh = Femtet.Gogh
+
+    # Set the mode after unloading.
+    Gogh.Galileo.Mode = Gogh.Galileo.nMode - 1
+
+    # Obtain the displacement of the measurement target point.
+    Gogh.Galileo.Vector = constants.GALILEO_DISPLACEMENT_C
+    succeed, (x, y, z) = Gogh.Galileo.GetVectorAtPoint_py(200, 0, 0)
+
+    # Calculate the angle formed by the line segment
+    # connecting the bending origin (100, 0) and the
+    # deformed point with the X-axis.
+    bending_point = np.array((100, 0))
+    bended_point = np.array((200 + 1000 * x.Real, 1000 * z.Real))
+    dx, dz = bended_point - bending_point
+    degree = np.arctan2(-dz, dx)
+
+    return degree * 360 / (2*np.pi)  # unit: degree
+
+
+if __name__ == '__main__':
+
+    # Initialize the numerical optimization problem.
+    # (determine the optimization method)
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=3,
+        )
+    )
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt(opt=opt)
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter("rot", 90, lower_bound=80, upper_bound=100)
+
+    # Add the objective function to the optimization problem.
+    # The target bending angle is 90 degrees.
+    femopt.add_objective(bending, name='final angle (degree)', direction=90)
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=10)
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample/gau_ex08_parametric.py

@@ -0,0 +1,59 @@
+"""Single-objective optimization: Self-inductance of a finite-length helical coil.
+
+Using Femtet's magnetic field analysis solver, design to achieve
+the target value for the self-inductance of a finite-length helical coil.
+
+Corresponding project: gau_ex08_parametric.femprj
+"""
+from optuna.integration.botorch import BoTorchSampler
+from pyfemtet.opt import FEMOpt, OptunaOptimizer
+
+
+def inductance(Femtet):
+    """Obtain the self-inductance.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Params:
+        Femtet: This is an instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+
+    Returns:
+        float: Self-inductance.
+    """
+    Gogh = Femtet.Gogh
+
+    coil_name = Gogh.Gauss.GetCoilList()[0]
+    return Gogh.Gauss.GetL(coil_name, coil_name)  # unit: F
+
+
+if __name__ == '__main__':
+
+    # Initialize the numerical optimization problem.
+    # (determine the optimization method)
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=5,
+        )
+    )
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt(opt=opt)
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter("helical_pitch", 6, lower_bound=4.2, upper_bound=8)
+    femopt.add_parameter("coil_radius", 10, lower_bound=1, upper_bound=10)
+    femopt.add_parameter("n_turns", 5, lower_bound=1, upper_bound=5)
+
+    # Add the objective function to the optimization problem.
+    # The target inductance is 0.1 uF.
+    femopt.add_objective(inductance, name='self-inductance (F)', direction=1e-7)
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample/her_ex40_parametric.py

@@ -0,0 +1,137 @@
+"""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.
+
+Corresponding project: her_ex40_parametric.femprj
+"""
+from time import sleep
+
+import numpy as np
+from scipy.signal import find_peaks
+from tqdm import tqdm
+from optuna.integration.botorch import BoTorchSampler
+
+from pyfemtet.core import SolveError
+from pyfemtet.opt import OptunaOptimizer, FEMOpt
+
+
+class SParameterCalculator:
+    """Calculating S-parameters and resonance frequencies."""
+    
+    def __init__(self):
+        self.freq = []
+        self.S = []
+        self.interpolated_function = None
+        self.resonance_frequency = None
+        self.minimum_S = None
+
+    def _get_freq_and_S_parameter(self, Femtet):
+        """Obtain the relationship between frequency and S-parameter"""
+
+        Gogh = Femtet.Gogh
+        
+        freq_list = []
+        dB_S_list = []
+        for mode in tqdm(range(Gogh.Hertz.nMode), 'Obtain frequency and S-parameter.'):
+            # mode setting
+            Gogh.Hertz.Mode = mode
+            sleep(0.01)
+
+            # Obtain frequency
+            freq = Gogh.Hertz.GetFreq().Real
+
+            # Obtain S(1, 1)
+            comp_S = Gogh.Hertz.GetSMatrix(0, 0)
+            norm = np.linalg.norm((comp_S.Real, comp_S.Imag))
+            dB_S = 20 * np.log10(norm)
+
+            # Save them
+            freq_list.append(freq)
+            dB_S_list.append(dB_S)
+
+        self.freq = freq_list
+        self.S = dB_S_list
+
+    def _calc_resonance_frequency(self):
+        """Compute the frequency that gives the first peak for S-parameter."""
+        peaks, _ = find_peaks(-np.array(self.S), height=None, threshold=None, distance=None, prominence=0.5, width=None, wlen=None, rel_height=0.5, plateau_size=None)
+        if len(peaks) == 0:
+            raise SolveError('No S(1,1) 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.
+
+        Note:
+            The objective or constraint function should take Femtet
+            as its first argument and return a float as the output.
+
+        Params:
+            Femtet: This is an instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+        
+        Returns:
+            float: A resonance frequency of the antenna.
+        """
+        self._get_freq_and_S_parameter(Femtet)
+        self._calc_resonance_frequency()
+        return self.resonance_frequency  # unit: Hz
+        
+
+def antenna_is_smaller_than_substrate(Femtet):
+    """Calculate the relationship between antenna size and board size.
+
+    This function is used to constrain the model
+    from breaking down while changing parameters.
+
+    Returns:
+        float: Difference between the substrate size and antenna size. Must be equal to or grater than 1 mm.
+    """
+    r = Femtet.GetVariableValue('antenna_radius')
+    w = Femtet.GetVariableValue('substrate_w')
+    return w / 2 - r  # unit: mm
+
+
+def port_is_inside_antenna(Femtet):
+    """Calculate the relationship between the feed port location and antenna size."""
+    r = Femtet.GetVariableValue('antenna_radius')
+    x = Femtet.GetVariableValue('port_x')
+    return r - x  # unit: mm. Must be equal to or grater than 1 mm.
+
+
+if __name__ == '__main__':
+    # Initialize the object for calculating frequency characteristics.
+    s = SParameterCalculator()
+
+    # Initialize the numerical optimization problem.
+    # (determine the optimization method)
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=10,
+        )
+    )
+    
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt(opt=opt)
+    
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter('antenna_radius', 10, 5, 20)
+    femopt.add_parameter('substrate_w', 50, 40, 60)
+    femopt.add_parameter('port_x', 5, 1, 20)
+
+    # Add the constraint function to the optimization problem.
+    femopt.add_constraint(antenna_is_smaller_than_substrate, 'antenna and substrate clearance', lower_bound=1)
+    femopt.add_constraint(port_is_inside_antenna, 'antenna and port clearance', lower_bound=1)
+
+    # Add the objective function to the optimization problem.
+    # The target frequency is 3.0 GHz.
+    femopt.add_objective(s.get_resonance_frequency, 'first resonant frequency(Hz)', direction=3.0 * 1e9)
+
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=15)
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample/paswat_ex1_parametric.py

@@ -0,0 +1,61 @@
+"""Multi-objective optimization: Air cooling of IC on a printed circuit board (forced convection).
+
+Using Femtet's simple fluid-thermal analysis solver,
+design a solution that reduces the chip temperature
+while minimizing the substrate size.
+
+Related project: paswat_ex1_parametric.femprj
+"""
+from pyfemtet.opt import FEMOpt
+
+
+def chip_temp(Femtet, chip_name):
+    """Obtain the maximum temperature of the chip.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Params:
+        Femtet: An instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+        chip_name (str): The body attribute name defined in femprj. Valid values are 'MAINCHIP' or 'SUBCHIP'.
+
+    Returns:
+        float: The maximum temperature of the body with the specified body attribute name.
+    """
+    Gogh = Femtet.Gogh
+
+    max_temperature, min_temperature, mean_temperature = Gogh.Watt.GetTemp(chip_name)
+
+    return max_temperature  # unit: degree
+
+
+def substrate_size(Femtet):
+    """Calculate the occupied area on the XY plane of the substrate."""
+    substrate_w = Femtet.GetVariableValue('substrate_w')
+    substrate_d = Femtet.GetVariableValue('substrate_d')
+    return substrate_w * substrate_d  # unit: mm2
+
+
+if __name__ == '__main__':
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt()
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=60)
+    femopt.add_parameter("substrate_d", 60, lower_bound=34, upper_bound=60)
+    femopt.add_parameter("rot", 0, lower_bound=0, upper_bound=180)
+
+    # Add the objective function to the optimization problem.
+    # The target bending angle is 90 degrees.
+    femopt.add_objective(chip_temp, name='max temp. of<br>MAINCHIP (degree)', direction='minimize', args=('MAINCHIP',))
+    femopt.add_objective(chip_temp, name='max temp. of<br>SUBCHIP (degree)', direction='minimize', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='substrate size (mm2)', direction='minimize')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=15)
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample/paswat_ex1_parametric_parallel.py

@@ -0,0 +1,62 @@
+"""Multi-objective optimization: Air cooling of IC on a printed circuit board (forced convection).
+
+Using Femtet's simple fluid-thermal analysis solver,
+design a solution that reduces the chip temperature
+while minimizing the substrate size.
+
+Related project: paswat_ex1_parametric.femprj
+"""
+from pyfemtet.opt import FEMOpt
+
+
+def chip_temp(Femtet, chip_name):
+    """Obtain the maximum temperature of the chip.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Params:
+        Femtet: An instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+        chip_name (str): The body attribute name defined in femprj. Valid values are 'MAINCHIP' or 'SUBCHIP'.
+
+    Returns:
+        float: The maximum temperature of the body with the specified body attribute name.
+    """
+    Gogh = Femtet.Gogh
+
+    max_temperature, min_temperature, mean_temperature = Gogh.Watt.GetTemp(chip_name)
+
+    return max_temperature  # unit: degree
+
+
+def substrate_size(Femtet):
+    """Calculate the occupied area on the XY plane of the substrate."""
+    substrate_w = Femtet.GetVariableValue('substrate_w')
+    substrate_d = Femtet.GetVariableValue('substrate_d')
+    return substrate_w * substrate_d  # unit: mm2
+
+
+if __name__ == '__main__':
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt()
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=60)
+    femopt.add_parameter("substrate_d", 60, lower_bound=34, upper_bound=60)
+    femopt.add_parameter("rot", 0, lower_bound=0, upper_bound=180)
+
+    # Add the objective function to the optimization problem.
+    # The target bending angle is 90 degrees.
+    femopt.add_objective(chip_temp, name='max temp. of<br>MAINCHIP (degree)', direction='minimize', args=('MAINCHIP',))
+    femopt.add_objective(chip_temp, name='max temp. of<br>SUBCHIP (degree)', direction='minimize', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='substrate size (mm2)', direction='minimize')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    # femopt.optimize(n_trials=15)
+    femopt.optimize(n_trials=30, n_parallel=3)  # This line is the only difference with no parallel pattern.
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample/wat_ex14_parametric.py

@@ -0,0 +1,59 @@
+"""Multi-objective optimization: heating element on substrate.
+
+Using Femtet's heat conduction analysis solver, we will design
+to reduce the chip temperature and shrink the board size.
+
+Corresponding project: wat_ex14_parametric.femprj
+"""
+from pyfemtet.opt import FEMOpt
+
+
+def chip_temp(Femtet, chip_name):
+    """Obtain the maximum temperature of the chip.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Params:
+        Femtet: An instance for manipulating Femtet with macros. For detailed information, please refer to "Femtet Macro Help".
+        chip_name (str): The body attribute name defined in femprj. Valid values are 'MAINCHIP' or 'SUBCHIP'.
+
+    Returns:
+        float: The maximum temperature of the body with the specified body attribute name.
+    """
+    Gogh = Femtet.Gogh
+
+    max_temperature, min_temperature, mean_temperature = Gogh.Watt.GetTemp(chip_name)
+
+    return max_temperature  # unit: degree
+
+
+def substrate_size(Femtet):
+    """Calculate the occupied area on the XY plane of the substrate."""
+    substrate_w = Femtet.GetVariableValue('substrate_w')
+    substrate_d = Femtet.GetVariableValue('substrate_d')
+    return substrate_w * substrate_d  # unit: mm2
+
+
+if __name__ == '__main__':
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt()
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    femopt.add_parameter("substrate_w", 40, lower_bound=22, upper_bound=40)
+    femopt.add_parameter("substrate_d", 60, lower_bound=33, upper_bound=60)
+
+    # Add the objective function to the optimization problem.
+    # The target bending angle is 90 degrees.
+    femopt.add_objective(chip_temp, name='max temp. of<br>MAINCHIP (degree)', direction='minimize', args=('MAINCHIP',))
+    femopt.add_objective(chip_temp, name='max temp. of<br>SUBCHIP (degree)', direction='minimize', args=('SUBCHIP',))
+    femopt.add_objective(substrate_size, name='substrate size')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=15)
+    femopt.terminate_all()

pyfemtet/opt/femprj_sample_jp/cad_ex01_NX_jp.py

@@ -0,0 +1,126 @@
+"""外部 CAD (NX) 連携
+
+Femtet の応力解析ソルバ、および
+Siemens 社製 CAD ソフト NX を用いて
+軽量かつ高剛性な H 型鋼の設計を行います。
+
+事前準備として、下記の手順を実行してください。
+- NX のインストール
+- C:\temp フォルダを作成する
+    - Note: NX が .x_t ファイルをこのフォルダに保存します。
+- 以下のファイルを同じフォルダに配置
+    - cad_ex01_NX_jp.py (このファイル)
+    - cad_ex01_NX.prt
+    - cad_ex01_NX_jp.femprj
+"""
+
+import os
+
+from win32com.client import constants
+
+from pyfemtet.opt import FEMOpt
+from pyfemtet.opt.interface import FemtetWithNXInterface
+from pyfemtet.core import ModelError
+
+
+here, me = os.path.split(__file__)
+os.chdir(here)
+
+
+def von_mises(Femtet):
+    """モデルの最大フォン・ミーゼス応力を取得します。
+
+    Note:
+        目的関数または制約関数は、
+        第一引数としてFemtetを受け取り、
+        戻り値としてfloat型を返す必要があります。
+
+    Warning:
+        CAD 連携機能では、意図しない位置に境界条件が設定される可能性があります。
+
+        この例では、境界条件が意図したとおりに割り当てられている場合、
+        最大変位は常に負になります。最大変位が正の場合、境界条件の割り当てが
+        失敗したとみなし、ModelError を送出します。
+
+        最適化中に ModelError、MeshError、または SolveError が発生した場合、
+        最適化プロセスは試行を失敗とみなし、次のトライアルにスキップします。
+    """
+
+    # 簡易的な境界条件の正しさチェック
+    dx, dy, dz = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+    if dz >= 0:
+        raise ModelError('境界条件の設定が間違っています。')
+
+    # ミーゼス応力計算
+    Gogh = Femtet.Gogh
+    Gogh.Galileo.Potential = constants.GALILEO_VON_MISES_C
+    succeed, (x, y, z), mises = Gogh.Galileo.GetMAXPotentialPoint_py(constants.CMPX_REAL_C)
+
+    return mises
+
+
+def mass(Femtet):
+    """モデルの質量を取得します。"""
+    return Femtet.Gogh.Galileo.GetMass('H_beam')
+
+
+def C_minus_B(Femtet, opt):
+    """C 寸法と B 寸法の差を計算します。
+
+    別の例では、次のスニペットを使用して設計変数にアクセスします。
+
+        A = Femtet.GetVariableValue('A')
+    
+    ただし、CAD 連携機能を使用する場合、設計変数が .femprj ファイルに
+    設定されていないため、この方法は機能しません。
+
+    CAD 連携機能を使用する場合、以下の方法で設計変数にアクセスすることができます。
+
+        # add_parameter() で追加したパラメータの変数名をキーとする辞書を得る方法
+        params: dict = opt.get_parameter()
+        A = params['A']
+
+    又は
+
+        # add_parameter() で追加した順のパラメータの値の配列を得る方法
+        values: np.ndarray = opt.get_parameter('values')
+        A, B, C = values
+
+    目的関数と拘束関数は、最初の引数の後に任意の変数を取ることができます。
+    FEMOpt のメンバ変数 opt には get_parameter() というメソッドがあります。
+    このメソッドによって add_parameter() で追加された設計変数を取得できます。
+    opt を第 2 引数として取ることにより、目的関数または拘束関数内で
+    get_parameter() を実行して設計変数を取得できます。
+    """
+    A, B, C = opt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # NX-Femtet 連携オブジェクトの初期化
+    # この処理により、Python プロセスは Femtet に接続を試みます。
+    fem = FemtetWithNXInterface(
+        prt_path='cad_ex01_NX.prt',
+        open_result_with_gui=False,
+    )
+
+    # FEMOpt オブジェクトの初期化 (最適化問題とFemtetとの接続を行います)
+    femopt = FEMOpt(fem=fem)
+
+    # 設計変数を最適化問題に追加 (femprj ファイルに登録されている変数を指定してください)
+    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.opt)
+
+    # 目的関数を最適化問題に追加
+    femopt.add_objective(von_mises, name='von Mises (Pa)')
+    femopt.add_objective(mass, name='mass (kg)')
+
+    # 最適化を実行
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()