pyfemtet 0.4.2__tar.gz → 0.4.3__tar.gz

{pyfemtet-0.4.2 → pyfemtet-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyfemtet
-Version: 0.4.2
+Version: 0.4.3
 Summary: Design parameter optimization using Femtet.
 Home-page: https://github.com/pyfemtet/pyfemtet
 License: BSD-3-Clause

pyfemtet-0.4.3/pyfemtet/FemtetPJTSample/her_ex40_parametric.py

@@ -0,0 +1,148 @@
+"""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
+from scipy.signal import find_peaks
+from tqdm import tqdm
+from optuna.integration.botorch import BoTorchSampler
+
+from pyfemtet.opt import OptunaOptimizer, FEMOpt
+
+
+class SParameterCalculator:
+    """This class is for 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_result_from_Femtet(self, Femtet):
+        """Obtain the relationship between frequency and S-parameter from the Femtet analysis results."""
+
+        # Preparation
+        Femtet.OpenCurrentResult(True)
+        Gogh = Femtet.Gogh
+        
+        # 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), 'Obtaining frequency and S-parameter'):
+            # Femtet result screen mode settings
+            Gogh.Hertz.Mode = mode
+            sleep(0.01)
+            # Get frequency
+            freq = Gogh.Hertz.GetFreq().Real
+            # 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):
+        """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('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.
+
+        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()
+        f = self.resonance_frequency * 1e-9
+        return f  # GHz
+        
+
+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.
+
+    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')
+    return Sx/2 - ant_r
+
+
+def port_is_inside_antenna(Femtet):
+    """Calculate the relationship between the feed port location and antenna size.
+
+    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')
+    return ant_r - xf
+
+
+if __name__ == '__main__':
+    # Define the object for calculating S-parameters and resonance frequencies.
+    s = SParameterCalculator()
+
+    # Define mathematical optimization object.
+    opt = OptunaOptimizer(
+        sampler_class=BoTorchSampler,
+        sampler_kwargs=dict(
+            n_startup_trials=10,
+        )
+    )
+    
+    # Define FEMOpt object (This process integrates mathematical optimization and FEM.).
+    femopt = FEMOpt(opt=opt)
+    
+    # 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)
+
+    # 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)
+
+    # 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.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.3/pyfemtet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.3"

pyfemtet-0.4.3/pyfemtet/opt/femprj_sample/cad_ex01_NX.py

@@ -0,0 +1,132 @@
+"""External CAD (NX) Integration
+
+Using Femtet's stress analysis solver and Siemens' CAD software NX,
+design a lightweight and high-strength H-shaped beam.
+
+As a preliminary step, please perform the following procedures:
+- Install NX
+- Create a C:\temp folder
+    - Note: NX will save a .x_t file in this folder.
+- Place the following files in the same folder:
+    - cad_ex01_NX.py (this file)
+    - cad_ex01_NX.prt
+    - cad_ex01_NX.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):
+    """Obtain the maximum von Mises stress of the model.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum z displacement is always negative.
+        If the maximum displacement is not negative, it is assumed that
+        boundary condition assignment has failed.
+        Then this function raises a ModelError.
+
+        If a ModelError, MeshError, or SolveError occurs during optimization,
+        the optimization process considers the attempt a failure and skips to
+        the next trial.
+    """
+
+    # Simple check for the correctness of boundary conditions.
+    dx, dy, dz = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+    if dz >= 0:
+        raise ModelError('Assigning unintended boundary conditions.')
+
+    # Von Mises stress calculation.
+    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):
+    """Obtain model mass."""
+    return Femtet.Gogh.Galileo.GetMass('H_beam')
+
+
+def C_minus_B(Femtet, opt):
+    """Calculate the difference between C and B dimensions.
+
+    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.
+
+        # How to obtain a dictionary with the variable names of parameters
+        # added by add_parameter() as keys.
+        params: dict = opt.get_parameter()
+        A = params['A']
+
+    Or
+
+        # How to obtain an array of values of parameters added in the order
+        # by add_parameter().
+        values: np.ndarray = opt.get_parameter('values')
+        A, B, C = values
+
+    Objective functions and constraint functions can take arbitrary variables
+    after the first argument.
+    The FEMOpt member variable `opt` has a method called get_parameter().
+    This method allows you to retrieve design variables added by add_parameter().
+    By taking `opt` as the second argument, you can execute get_parameter()
+    within the objective or constraint function to retrieve design variables.
+    """
+    A, B, C = opt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # Initialize NX-Femtet integration object.
+    # At this point, Python is connected to the Femtet.
+    fem = FemtetWithNXInterface(
+        prt_path='cad_ex01_NX.prt',
+        open_result_with_gui=False,  # To calculate von Mises stress, set this argument to False. See Femtet Macro Help.
+    )
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt(fem=fem)
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    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 the constraint function to the optimization problem.
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
+
+    # Add the objective function to the optimization problem.
+    femopt.add_objective(von_mises, name='von Mises (Pa)')
+    femopt.add_objective(mass, name='mass (kg)')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.3/pyfemtet/opt/femprj_sample/cad_ex01_SW.py

@@ -0,0 +1,132 @@
+"""External CAD (SOLIDWORKS) Integration
+
+Using Femtet's stress analysis solver and Dassault Systemes' CAD software SOLIDWORKS,
+design a lightweight and high-strength H-shaped beam.
+
+As a preliminary step, please perform the following procedures:
+- Install SOLIDWORKS
+- Create a C:\temp folder
+    - Note: SOLIDWORKS will save a .x_t file in this folder.
+- Place the following files in the same folder:
+    - cad_ex01_SW.py (this file)
+    - cad_ex01_SW.SLDPRT
+    - cad_ex01_SW.femprj
+"""
+
+import os
+
+from win32com.client import constants
+
+from pyfemtet.opt import FEMOpt
+from pyfemtet.opt.interface import FemtetWithSolidworksInterface
+from pyfemtet.core import ModelError
+
+
+here, me = os.path.split(__file__)
+os.chdir(here)
+
+
+def von_mises(Femtet):
+    """Obtain the maximum von Mises stress of the model.
+
+    Note:
+        The objective or constraint function should take Femtet
+        as its first argument and return a float as the output.
+
+    Warning:
+        CAD integration may assign boundary conditions to unintended locations.
+
+        In this example, if the boundary conditions are assigned as intended,
+        the maximum z displacement is always negative.
+        If the maximum displacement is not negative, it is assumed that
+        boundary condition assignment has failed.
+        Then this function raises a ModelError.
+
+        If a ModelError, MeshError, or SolveError occurs during optimization,
+        the optimization process considers the attempt a failure and skips to
+        the next trial.
+    """
+
+    # Simple check for the correctness of boundary conditions.
+    dx, dy, dz = Femtet.Gogh.Galileo.GetMaxDisplacement_py()
+    if dz >= 0:
+        raise ModelError('Assigning unintended boundary conditions.')
+
+    # Von Mises stress calculation.
+    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):
+    """Obtain model mass."""
+    return Femtet.Gogh.Galileo.GetMass('H_beam')
+
+
+def C_minus_B(Femtet, opt):
+    """Calculate the difference between C and B dimensions.
+
+    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.
+
+        # How to obtain a dictionary with the variable names of parameters
+        # added by add_parameter() as keys.
+        params: dict = opt.get_parameter()
+        A = params['A']
+
+    Or
+
+        # How to obtain an array of values of parameters added in the order
+        # by add_parameter().
+        values: np.ndarray = opt.get_parameter('values')
+        A, B, C = values
+
+    Objective functions and constraint functions can take arbitrary variables
+    after the first argument.
+    The FEMOpt member variable `opt` has a method called get_parameter().
+    This method allows you to retrieve design variables added by add_parameter().
+    By taking `opt` as the second argument, you can execute get_parameter()
+    within the objective or constraint function to retrieve design variables.
+    """
+    A, B, C = opt.get_parameter('values')
+    return C - B
+
+
+if __name__ == '__main__':
+
+    # Initialize NX-Femtet integration object.
+    # At this point, Python is connected to the Femtet.
+    fem = FemtetWithSolidworksInterface(
+        sldprt_path='cad_ex01_SW.SLDPRT',
+        open_result_with_gui=False,  # To calculate von Mises stress, set this argument to False. See Femtet Macro Help.
+    )
+
+    # Initialize the FEMOpt object.
+    # (establish connection between the optimization problem and Femtet)
+    femopt = FEMOpt(fem=fem)
+
+    # Add design variables to the optimization problem.
+    # (Specify the variables registered in the femprj file.)
+    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 the constraint function to the optimization problem.
+    femopt.add_constraint(C_minus_B, 'C>B', lower_bound=1, args=femopt.opt)
+
+    # Add the objective function to the optimization problem.
+    femopt.add_objective(von_mises, name='von Mises (Pa)')
+    femopt.add_objective(mass, name='mass (kg)')
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=20)
+    femopt.terminate_all()

pyfemtet-0.4.3/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-0.4.3/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()