pyfemtet 0.8.7__py3-none-any.whl → 0.8.9__py3-none-any.whl

pyfemtet/__init__.py

@@ -1 +1 @@
-__version__ = "0.8.7"
+__version__ = "0.8.9"

pyfemtet/opt/_femopt.py

@@ -131,7 +131,7 @@ class FEMOpt:
         # メンバーの宣言
         self.client = None
         self.status = None  # actor
-        self.history = None  # actor
+        self.history: History = None
         self.worker_status_list = None  # [actor]
         self.monitor_process_future = None
         self.monitor_server_kwargs = dict()

pyfemtet/opt/_femopt_core.py

@@ -553,7 +553,7 @@ class History:
             hv_reference=None,
     ):
         # hypervolume 計算メソッド
-        self._hv_reference = hv_reference or 'dynamic-pareto'
+        self._hv_reference = 'dynamic-pareto' if hv_reference is None else hv_reference
 
         # 引数の処理
         self.path = history_path  # .csv
@@ -728,6 +728,14 @@ class History:
 
         return columns, meta_columns
 
+    def generate_hidden_infeasible_result(self):
+        y = np.full_like(np.zeros(len(self.obj_names)), np.nan)
+        c = np.full_like(np.zeros(len(self.cns_names)), np.nan)
+        return y, c
+
+    def is_hidden_infeasible_result(self, y):
+        return np.all(np.isnan(y))
+
     def record(
             self,
             parameters,
@@ -780,7 +788,7 @@ class History:
             feasible_list.append(is_feasible(cns_value, cns.lb, cns.ub))
 
         # feasibility
-        row.append(all(feasible_list))
+        row.append(all(feasible_list) and not self.is_hidden_infeasible_result(obj_values))
 
         # the others
         row.append(-1.)  # dummy hypervolume
@@ -892,7 +900,29 @@ class History:
                     ret.append(row)
             return np.array(ret).max(axis=0)
 
-        if self._hv_reference == 'dynamic-pareto':
+        if (
+                isinstance(self._hv_reference, np.ndarray)
+                or isinstance(self._hv_reference, list)
+        ):
+            _buff = np.array(self._hv_reference)
+            assert _buff.shape == (len(self.obj_names),)
+
+            ref_point = np.array(
+                [obj.convert(raw_value) for obj, raw_value in zip(objectives.values(), _buff)]
+            )
+
+            _buff = get_pareto(objective_values)
+
+            pareto_set = np.empty((0, len(objectives)))
+            for pareto_sol in _buff:
+                if all(pareto_sol < ref_point):
+                    pareto_set = np.concatenate([pareto_set, [pareto_sol]], axis=0)
+
+            hv = compute_hypervolume(pareto_set, ref_point)
+            df.loc[len(df) - 1, 'hypervolume'] = hv
+            return
+
+        elif self._hv_reference == 'dynamic-pareto':
             pareto_set, pareto_set_list = get_pareto(objective_values, with_partial=True)
             for i, partial_pareto_set in enumerate(pareto_set_list):
                 # 並列計算時など Valid な解がまだ一つもない場合は pareto_set が長さ 0 になる
@@ -943,28 +973,6 @@ class History:
                 df.loc[len(df) - 1, 'hypervolume'] = hv
             return
 
-        elif (
-                isinstance(self._hv_reference, np.ndarray)
-                or isinstance(self._hv_reference, list)
-        ):
-            _buff = np.array(self._hv_reference)
-            assert _buff.shape == (len(self.obj_names),)
-
-            ref_point = np.array(
-                [obj.convert(raw_value) for obj, raw_value in zip(objectives.values(), _buff)]
-            )
-
-            _buff = get_pareto(objective_values)
-
-            pareto_set = np.empty((0, len(objectives)))
-            for pareto_sol in _buff:
-                if all(pareto_sol < ref_point):
-                    pareto_set = np.concatenate([pareto_set, [pareto_sol]], axis=0)
-
-            hv = compute_hypervolume(pareto_set, ref_point)
-            df.loc[len(df) - 1, 'hypervolume'] = hv
-            return
-
         else:
             raise NotImplementedError(f'Invalid Hypervolume reference point calculation method: {self._hv_reference}')
 

pyfemtet/opt/_test_utils/record_history.py

@@ -92,6 +92,7 @@ def is_equal_result(ref_path, dif_path, log_path=None, threashold=0.05):
     assert len(ref_columns) == len(dif_columns), "結果 csv の column 数が異なります。"
     assert len(ref_df) == len(dif_df), "結果 csv の row 数が異なります。"
     assert difference <= threashold*100, f"前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% を超えています。"
+    print(f"OK! 前回の結果との平均差異が {int(difference)}% で {int(threashold*100)}% 以下です。")
 
 
 def _get_simplified_df_values(csv_path, exclude_columns=None):

pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart.py

@@ -0,0 +1,99 @@
+import os
+from time import sleep
+
+from optuna.samplers import RandomSampler, NSGAIISampler, GPSampler, BaseSampler
+
+from pyfemtet.opt import FEMOpt, FemtetInterface, OptunaOptimizer
+
+os.chdir(os.path.dirname(__file__))
+
+
+def get_res_freq(Femtet):
+    Galileo = Femtet.Gogh.Galileo
+    Galileo.Mode = 0
+    sleep(0.01)
+    return Galileo.GetFreq().Real
+
+
+def main(n_trials, sampler_class: type[BaseSampler], sampler_kwargs: dict):
+    """Main function
+
+    length
+    using different algorithms for each restarting.
+
+    So this main function requires n_trials and sampler_class.
+
+    Args:
+
+        n_trials (int):
+            How many additional succeeded trials
+            to terminate optimization.
+
+        sampler_class (type[optuna.samplers.BaseSampler]):
+            The algorithm we use.
+
+        sampler_kwargs (dict):
+            The arguments of sampler.
+
+    """
+
+
+    # Connect to Femtet.
+    fem = FemtetInterface(
+        femprj_path='gal_ex13_parametric.femprj',
+    )
+
+    # Initialize the optimization object.
+    opt = OptunaOptimizer(
+        sampler_class=sampler_class,
+        sampler_kwargs=sampler_kwargs,
+    )
+
+    # To restart, it is necessary to inform the new optimization program
+    # about the history of the previous optimization.
+    # By specifying a csv for the `history_path` argument of FEMOpt,
+    # if it does not exist, a new csv file will be created,
+    # and if it exists, optimization will continue from that csv file.
+    #
+    # Note:
+    #   When restarting, the number and names of variables,
+    #   as well as the number and names of objective functions
+    #   and constraints must be consistent.
+    #   However, you can change the bounds of variables,
+    #   direction of objective functions, and content of constraints.
+    #
+    # Note:
+    #   When using OptunaOptimizer, the .db file with the same name
+    #   (in this case restarting-sample.db) that is saved along with
+    #   csv is required to be  in the same folder as the csv file.
+    femopt = FEMOpt(
+        fem=fem,
+        opt=opt,
+        history_path='restarting-sample.csv'
+    )
+
+    # Set the design variables.
+    femopt.add_parameter('length', 0.1, 0.02, 0.2)
+    femopt.add_parameter('width', 0.01, 0.001, 0.02)
+    femopt.add_parameter('base_radius', 0.008, 0.006, 0.01)
+
+    # Set the objective function.
+    femopt.add_objective(fun=get_res_freq, name='First Resonant Frequency (Hz)', direction=800)
+
+    # Run optimization.
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=n_trials, confirm_before_exit=False)
+
+
+if __name__ == '__main__':
+    # First, we will perform 3 optimizations using the RandomSampler.
+    main(3, RandomSampler, {})
+
+    # Next, we will perform 3 optimizations using the NSGAIISampler.
+    main(3, NSGAIISampler, {})
+
+    # Finally, we will perform 3 optimizations using the GPSampler.
+    main(3, GPSampler, {'n_startup_trials': 0, 'deterministic_objective': True})
+
+    # After this program ends, you can continue further with
+    # restarting-sample.csv and the .db file.

pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart_jp.py

@@ -0,0 +1,102 @@
+import os
+from time import sleep
+
+from optuna.samplers import RandomSampler, NSGAIISampler, GPSampler, BaseSampler
+
+from pyfemtet.opt import FEMOpt, FemtetInterface, OptunaOptimizer
+
+os.chdir(os.path.dirname(__file__))
+
+
+def get_res_freq(Femtet):
+    Galileo = Femtet.Gogh.Galileo
+    Galileo.Mode = 0
+    sleep(0.01)
+    return Galileo.GetFreq().Real
+
+
+def main(n_trials, sampler_class: type[BaseSampler], sampler_kwargs: dict):
+    """メイン関数
+
+    このサンプルは最適化を途中で中断して続きから行う場合で、
+    各リスタートで異なるアルゴリズムを使用して
+    最適化を再開する方法を示しています。
+
+    このメイン関数は n_trials と sampler_class を与えると
+    その回数、アルゴリズムに応じて最適化を行います。
+
+    Args:
+
+        n_trials (int):
+            最適化を終了するために必要な追加の成功した試行回数。
+
+        sampler_class (type[optuna.samplers.BaseSampler]):
+            使用するアルゴリズム。
+        
+        sampler_kwargs (dict):
+            アルゴリズムの引数。
+
+    """
+
+
+    # Femtet に接続します。
+    fem = FemtetInterface(
+        femprj_path='gal_ex13_parametric.femprj',
+    )
+
+    # 最適化オブジェクトを初期化します。
+    opt = OptunaOptimizer(
+        sampler_class=sampler_class,
+        sampler_kwargs=sampler_kwargs,
+    )
+
+    # リスタートするためには以前の最適化の履歴を
+    # 新しい最適化プログラムに知らせる必要があります。
+    # FEMOpt の `history_path` 引数に csv を指定すると、
+    # それが存在しない場合、新しい csv ファイルを作り、
+    # それが存在する場合、その csv ファイルの続きから
+    # 最適化を実行します。
+    #
+    # 注意:
+    #   リスタートする場合、変数の数と名前、目的関数の数と
+    #   名前、および拘束関数の数と名前が一貫している必要が
+    #   あります。
+    #   ただし、変数の上下限や目的関数の方向、拘束関数の内容
+    #   などは変更できます。
+    #
+    # 注意:
+    #   OptunaOptimizer を使用する場合、csv と同名の
+    #   .db ファイル (ここでは restarting-sample.db) が
+    #   csv ファイルと同じフォルダにある必要があります。
+    femopt = FEMOpt(
+        fem=fem,
+        opt=opt,
+        history_path='restarting-sample.csv'
+    )
+
+    # 設計パラメータを指定します。
+    femopt.add_parameter('length', 0.1, 0.02, 0.2)
+    femopt.add_parameter('width', 0.01, 0.001, 0.02)
+    femopt.add_parameter('base_radius', 0.008, 0.006, 0.01)
+
+    # 目的関数を指定します。
+    femopt.add_objective(fun=get_res_freq, name='First Resonant Frequency (Hz)', direction=800)
+
+    # 最適化を実行します。
+    femopt.set_random_seed(42)
+    femopt.optimize(n_trials=n_trials, confirm_before_exit=False)
+
+
+if __name__ == '__main__':
+    # 最初に、RandomSampler を使用して 3 回計算を行います。
+    main(3, RandomSampler, {})
+
+    # 次に、NSGAIISampler を使用して 3 回計算を行います。
+    main(3, NSGAIISampler, {})
+
+    #  最後に、GPSampler を使用して 3 回計算を行います。
+    main(3, GPSampler, {'n_startup_trials': 0, 'deterministic_objective': True})
+
+    # このプログラム終了後、
+    # restarting-sample.csv と同名の .db ファイルを用いて
+    # さらに続きの最適化を行うことができます。

pyfemtet/opt/interface/_femtet.py

@@ -201,6 +201,40 @@ class FemtetInterface(FEMInterface):
             **kwargs
         )
 
+    def use_parametric_output_as_objective(self, number: int, direction: str | float = 'minimize') -> None:
+        """Use output setting of Femtet parametric analysis as an objective function.
+
+        Args:
+            number (int): The index of output settings tab in parametric analysis dialog of Femtet. Starts at 1.
+            direction (str | float): Objective direction. Valid input is one of 'minimize', 'maximize' or a specific value. Defaults to 'minimize'.
+
+        Returns:
+            None
+
+        """
+        # check
+        if isinstance(direction, str):
+            if direction not in ('minimize', 'maximize'):
+                raise ValueError(f'direction must be one of "minimize", "maximize" or a specific value. Passed value is {direction}')
+        else:
+            try:
+                direction = float(direction)
+            except (TypeError, ValueError):
+                raise ValueError(f'direction must be one of "minimize", "maximize" or a specific value. Passed value is {direction}')
+
+        index = {number - 1: direction}
+
+        if self.parametric_output_indexes_use_as_objective is None:
+            self.parametric_output_indexes_use_as_objective = index
+
+        else:
+            self.parametric_output_indexes_use_as_objective.update(index)
+
+        # TODO: FEMInterface.__init__ の仕様を変えたらここも変える
+        self.kwargs['parametric_output_indexes_use_as_objective'] = self.parametric_output_indexes_use_as_objective
+
+
+
     def __del__(self):
         self.quit()
         # CoUninitialize()  # Win32 exception occurred releasing IUnknown at 0x0000022427692748
@@ -682,6 +716,14 @@ class FemtetInterface(FEMInterface):
 
         if self.parametric_output_indexes_use_as_objective is not None:
             from pyfemtet.opt.interface._femtet_parametric import solve_via_parametric_dll
+
+            pdt_path = self.Femtet.ResultFilePath + '.pdt'
+
+            # 前のものが残っているとややこしいので消しておく
+            if os.path.exists(pdt_path):
+                os.remove(pdt_path)
+
+            # parametric analysis 経由で解析
             self._call_femtet_api(
                 fun=solve_via_parametric_dll,
                 return_value_if_failed=False,
@@ -690,8 +732,23 @@ class FemtetInterface(FEMInterface):
                 is_Gaudi_method=True,
                 args=(self.Femtet,),
             )
+
+            # parametric analysis の場合
+            # ダイアログで「解析結果を保存する」に
+            # チェックがついていないと次にすべき
+            # OpenCurrentResult に失敗するので
+            # parametric の場合も pdt を保存する
+            self._call_femtet_api(
+                fun=self.Femtet.SavePDT,
+                args=(pdt_path, True),
+                return_value_if_failed=False,
+                if_error=SolveError,
+                error_message=Msg.ERR_FAILED_TO_SAVE_PDT,
+                is_Gaudi_method=False,
+            )
+
         else:
-            # # ソルブする
+            # ソルブする
             self._call_femtet_api(
                 self.Femtet.Solve,
                 False,

pyfemtet/opt/interface/_surrogate/_base.py

@@ -16,37 +16,35 @@ class SurrogateModelInterfaceBase(FEMInterface, ABC):
     def __init__(
             self,
             history_path: str = None,
-            history: History = None,
-            override_objective: bool = True,
+            train_history: History = None,
     ):
 
-        self.history: History
+        self.train_history: History
         self.model: Any
         self.prm: dict[str, float] = dict()
         self.obj: dict[str, float] = dict()
         self.df_prm: pd.DataFrame
         self.df_obj: pd.DataFrame
-        self.override_objective: bool = override_objective
 
-        # history_path が与えられた場合、history をコンストラクトする
+        # history_path が与えられた場合、train_history をコンストラクトする
         if history_path is not None:
-            history = History(history_path=history_path)
+            train_history = History(history_path=history_path)
 
-        # history が与えられるかコンストラクトされている場合
-        if history is not None:
+        # train_history が与えられるかコンストラクトされている場合
+        if train_history is not None:
             # 学習データを準備する
-            df_prm = history.get_df()[history.prm_names]
-            df_obj = history.get_df()[history.obj_names]
+            df_prm = train_history.get_df()[train_history.prm_names]
+            df_obj = train_history.get_df()[train_history.obj_names]
 
             # obj の名前を作る
-            for obj_name in history.obj_names:
+            for obj_name in train_history.obj_names:
                 self.obj[obj_name] = np.nan
 
             # prm の名前を作る
-            for prm_name in history.prm_names:
+            for prm_name in train_history.prm_names:
                 self.prm[prm_name] = np.nan
 
-            self.history = history
+            self.train_history = train_history
 
         # history から作らない場合、引数チェック
         else:
@@ -58,8 +56,7 @@ class SurrogateModelInterfaceBase(FEMInterface, ABC):
 
         FEMInterface.__init__(
             self,
-            history=history,  # コンストラクト済み history を渡せば並列計算時も何もしなくてよい
-            override_objective=self.override_objective
+            train_history=train_history,  # コンストラクト済み train_history を渡せば並列計算時も何もしなくてよい
         )
 
     def filter_feasible(self, x: np.ndarray, y: np.ndarray, return_feasibility=False):
@@ -73,10 +70,14 @@ class SurrogateModelInterfaceBase(FEMInterface, ABC):
             return x[feasible_idx], y[feasible_idx]
 
     def _setup_after_parallel(self, *args, **kwargs):
-        if self.override_objective:
-            opt: AbstractOptimizer = kwargs['opt']
-            obj: Objective
-            for obj_name, obj in opt.objectives.items():
+        opt: AbstractOptimizer = kwargs['opt']
+        obj: Objective
+
+        # add_objective された目的のうち、
+        # training data に含まれる名前で
+        # あるものは fun を上書き
+        for obj_name, obj in opt.objectives.items():
+            if obj_name in self.train_history.obj_names:
                 obj.fun = lambda obj_name_=obj_name: self.obj[obj_name_]
 
     def update_parameter(self, parameters: pd.DataFrame, with_warning=False) -> Optional[List[str]]:

pyfemtet/opt/interface/_surrogate/_chaospy.py

@@ -27,7 +27,7 @@ class PolynomialChaosInterface(SurrogateModelInterfaceBase):
 
         # train model
         self.model = PolynomialExpansionModel()
-        self.model.set_bounds_from_history(self.history)
+        self.model.set_bounds_from_history(self.train_history)
         self.train()
 
     def update(self, parameters: pd.DataFrame) -> None:
@@ -37,13 +37,13 @@ class PolynomialChaosInterface(SurrogateModelInterfaceBase):
         )
 
         # history.prm_name 順に並べ替え
-        x = np.array([self.prm[k] for k in self.history.prm_names])
+        x = np.array([self.prm[k] for k in self.train_history.prm_names])
 
         # prediction
         dist_mean, _ = self.model.predict(x)
 
         # 目的関数の更新
-        self.obj = {obj_name: value for obj_name, value in zip(self.history.obj_names, dist_mean)}
+        self.obj = {obj_name: value for obj_name, value in zip(self.train_history.obj_names, dist_mean)}
 
 
 if __name__ == '__main__':

pyfemtet/opt/interface/_surrogate/_singletaskgp.py

@@ -40,12 +40,12 @@ class PoFBoTorchInterface(SurrogateModelInterfaceBase):
 
         # model training
         self.model = SingleTaskGPModel()
-        self.model.set_bounds_from_history(self.history)
+        self.model.set_bounds_from_history(self.train_history)
         self.train()
 
         # model_f training
         self.model_f = SingleTaskGPModel(is_noise_free=False)
-        self.model_f.set_bounds_from_history(self.history)
+        self.model_f.set_bounds_from_history(self.train_history)
         self.train_f()
 
     def update(self, parameters: pd.DataFrame) -> None:
@@ -54,8 +54,8 @@ class PoFBoTorchInterface(SurrogateModelInterfaceBase):
             self, parameters
         )
 
-        # history.prm_name 順に並べ替え
-        x = np.array([self.prm[k] for k in self.history.prm_names])
+        # train_history.prm_name 順に並べ替え
+        x = np.array([self.prm[k] for k in self.train_history.prm_names])
 
         # feasibility の計算
         mean_f, std_f = self.model_f.predict(np.array([x]))
@@ -63,9 +63,9 @@ class PoFBoTorchInterface(SurrogateModelInterfaceBase):
         if pof < self.threshold:
             raise SolveError(Msg.INFO_POF_IS_LESS_THAN_THRESHOLD)
 
-        # 実際の計算(mean は history.obj_names 順)
+        # 実際の計算(現時点で mean は train_history.obj_names 順)
         _mean, _std = self.model.predict(np.array([x]))
         mean = _mean[0]
 
         # 目的関数の更新
-        self.obj = {obj_name: value for obj_name, value in zip(self.history.obj_names, mean)}
+        self.obj = {obj_name: value for obj_name, value in zip(self.train_history.obj_names, mean)}

pyfemtet/opt/optimizer/_base.py

@@ -155,11 +155,6 @@ class AbstractOptimizer(ABC):
         """Setup before parallel processes are launched."""
         pass
 
-    def generate_infeasible_result(self):
-        y = np.full_like(np.zeros(len(self.objectives)), np.nan)
-        c = np.full_like(np.zeros(len(self.constraints)), np.nan)
-        return y, y, c
-
     # ===== calc =====
     def f(self, x: np.ndarray, _record_infeasible=False) -> list[np.ndarray]:
         """Calculate objectives and constraints.
@@ -208,7 +203,8 @@ class AbstractOptimizer(ABC):
             c = [cns.calc(self.fem) for cns in self.constraints.values()]
 
         else:
-            y, _y, c = self.generate_infeasible_result()
+            y, c = self.history.generate_hidden_infeasible_result()
+            _y = y
 
         # register to history
         df_to_opt = self.variables.get_variables(

pyfemtet/opt/optimizer/_optuna/_optuna.py

@@ -206,10 +206,10 @@ class OptunaOptimizer(AbstractOptimizer):
         """Create storage, study and set initial parameter."""
 
         # create storage
-        self.study_name = os.path.basename(self.history.path)
-        storage_path = self.history.path.replace('.csv', '.db')  # history と同じところに保存
+        self.study_name = 'pyfemtet-study'
+        storage_path = os.path.splitext(self.history.path)[0] + '.db'  # history と同じところに保存
         if self.is_cluster:  # remote cluster なら scheduler の working dir に保存
-            storage_path = os.path.basename(self.history.path).replace('.csv', '.db')
+            storage_path = os.path.splitext(os.path.basename(self.history.path))[0] + '.db'
 
         # callback to terminate
         if self.n_trials is not None:
@@ -374,6 +374,17 @@ class OptunaOptimizer(AbstractOptimizer):
             sampler._pyfemtet_optimizer = self
 
         # load study
+        self.storage: optuna.storages.BaseStorage
+        studies = self.storage.get_all_studies()
+        if self.study_name in [s.study_name for s in studies]:
+            pass
+
+        elif len(studies) >= 1:
+            self.study_name = studies[-1].study_name
+
+        else:
+            raise ValueError('An empty db is passed.')
+
         study = optuna.load_study(
             study_name=self.study_name,
             storage=self.storage,

pyfemtet/opt/samples/femprj_sample/gau_ex12_parametric.py

@@ -0,0 +1,52 @@
+"""Optimization using parametric analysis output settings as the objective function
+
+This demo shows how to use the values outputted by Femtet's parametric
+analysis output setting feature as the objective function for optimization.
+This feature allows you to perform optimization without coding the objective function.
+
+
+Note:
+
+    Please be aware of the following when using this feature.
+
+    - The sweep table from the parametric analysis will be deleted.
+    - Output settings that produce complex numbers or vectors will only use
+      the first value as the objective function. (For complex numbers, it will be
+      the real part, and for vector values, it will be components such as X.)
+
+
+Corresponding project: gau_ex12_parametric.femprj
+
+"""
+
+from pyfemtet.opt import FEMOpt, FemtetInterface
+
+
+if __name__ == '__main__':
+
+    # Initialize an object to connect to
+    # Femtet for referencing Femtet settings.
+    fem = FemtetInterface()
+
+    # Set the output settings of the parametric analysis as the objective function.
+    # `number` is the index from the `results output settings` tab of the
+    # Femtet parametric analysis dialog, and `direction` is
+    # the goal of that objective function (similar to FEMOpt.add_objective).
+
+    # Mutual inductance
+    fem.use_parametric_output_as_objective(number=1, direction=1.5e-7)
+
+    # Strength of magnetic field at the center of the coil
+    fem.use_parametric_output_as_objective(number=2, direction='minimize')
+
+    # Initialize optimization object.
+    # Pass in the previously initialized fem object.
+    femopt = FEMOpt(fem=fem)
+
+    #  Set parameters.
+    femopt.add_parameter('in_radius', 10, 5, 10)
+    femopt.add_parameter('out_radius', 20, 20, 25)
+
+    # Execute optimization.
+    femopt.set_random_seed(42)  # Fix random seed
+    femopt.optimize(n_trials=20)

pyfemtet/opt/samples/femprj_sample_jp/gau_ex12_parametric_jp.py

@@ -0,0 +1,52 @@
+"""パラメトリック解析出力設定を目的関数とする最適化
+
+Femtet のパラメトリック解析の結果出力設定機能で出力される値を
+最適化の目的関数として使用する方法をデモします。
+この機能により、目的関数をコーディングすることなく
+最適化を実施できます。
+
+
+注意:
+
+    この機能を使う際は、以下のことに注意してください。
+
+    - パラメトリック解析のスイープテーブルが削除されます。
+    - 複素数やベクトルを出力する出力設定は、第一の値のみが
+      目的関数として使用されます。（複素数の場合は実数、
+      ベクトル値の場合は X 成分など）
+
+
+対応するプロジェクト: gau_ex12_parametric.femprj
+"""
+
+from pyfemtet.opt import FEMOpt, FemtetInterface
+
+
+if __name__ == '__main__':
+
+    # Femtet の設定を参照するため、Femtet と接続を
+    # 行うためのオブジェクトを初期化します。
+    fem = FemtetInterface()
+
+    # パラメトリック解析の結果出力設定を目的関数にします。
+    # number は Femtet パラメトリック解析ダイアログの
+    # 結果出力設定タブのテーブルの番号で、direction は
+    # その目的関数の目標です(FEMOpt.add_objective と同様)。
+
+    # 相互インダクタンス
+    fem.use_parametric_output_as_objective(number=1, direction=1.5e-7)
+
+    # コイル中央の磁界の強さ
+    fem.use_parametric_output_as_objective(number=2, direction='minimize')
+
+    # 最適化用オブジェクトを初期化します。
+    # さきほど初期化した fem を渡します。
+    femopt = FEMOpt(fem=fem)
+
+    # パラメータを設定します。
+    femopt.add_parameter('in_radius', 10, 5, 10)
+    femopt.add_parameter('out_radius', 20, 20, 25)
+
+    # 最適化を実行します。
+    femopt.set_random_seed(42)  # 乱数シードの固定
+    femopt.optimize(n_trials=20)

{pyfemtet-0.8.7.dist-info → pyfemtet-0.8.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyfemtet
-Version: 0.8.7
+Version: 0.8.9
 Summary: Design parameter optimization using Femtet.
 License: BSD-3-Clause
 Author: kazuma.naito

{pyfemtet-0.8.7.dist-info → pyfemtet-0.8.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pyfemtet/__init__.py,sha256=04WO81p8xrQAHiTKqHaDkKWih6M2Y3Hy-UCNVwih4Zc,21
+pyfemtet/__init__.py,sha256=jBrmFTf-nNFPcJTuyxzw1H9WEW7G7OpCejEb8xk5m-U,21
 pyfemtet/_femtet_config_util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyfemtet/_femtet_config_util/autosave.py,sha256=dNirA9XGuFehas8_Jkj2BW9GOzMbPyhnt1WHcH_ObSU,2070
 pyfemtet/_femtet_config_util/exit.py,sha256=0BWID-tjOkmZwmgPFkcJMkWW39voccz5ARIBWvZbHaw,1877
@@ -24,16 +24,19 @@ pyfemtet/dispatch_extensions/_impl.py,sha256=yH_yeAnQ-Xi9GfjX-FQt9u3yHnrLYIteRb6
 pyfemtet/logger/__init__.py,sha256=UOJ9n_U2xwdTrp0Xgg-N6geySxNzKqTBQlXsaH0kW_w,420
 pyfemtet/logger/_impl.py,sha256=rsAd0HpmveOaLS39ucp3U2OcDhQMWjC5fnVGhbJtWVw,6375
 pyfemtet/opt/__init__.py,sha256=wRR8LbEhb5I6MUgmnCgjB6-tqHlOVxDIo7yPkq0QbBs,758
-pyfemtet/opt/_femopt.py,sha256=ZhwOK1QYwo7Xk67qEOm4biKXzdIW2AUHYvgklBREDm8,40587
-pyfemtet/opt/_femopt_core.py,sha256=kxKh4_TdXR4LBgv8WibPiZ5Pe9apJd5ArBCfnhBwcCQ,38969
+pyfemtet/opt/_femopt.py,sha256=9-naHBWBVCd2jkIldhO_whrOh6AmpQLXUsdzyYKZyco,40587
+pyfemtet/opt/_femopt_core.py,sha256=hMnb5UD7R_FfF6VvNLakJedIdjv7B3i--nsvqhdue2M,39328
 pyfemtet/opt/_test_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyfemtet/opt/_test_utils/control_femtet.py,sha256=8oAl9y5V2n8Nnsgx_ebcZVzwFt1eI3swkdiKg6pg3-M,1085
 pyfemtet/opt/_test_utils/hyper_sphere.py,sha256=nQhw8EIY0DwvcTqrbKhkxiITLZifr4-nG77E-_6ggmA,700
-pyfemtet/opt/_test_utils/record_history.py,sha256=zsa1w73K7NLBqbj7yuv0fWVJvZtWdiI0eCaUoAn5Bjg,4239
+pyfemtet/opt/_test_utils/record_history.py,sha256=7V2LCZ8F985c_NNUVu-K7_2-p2mwG1lRMZhkYhSy_Dw,4356
 pyfemtet/opt/advanced_samples/excel_ui/(ref) original_project.femprj,sha256=5OqZfynTpVCrgEIOBOMYuDGaMvepi5lojVNFr1jAsEI,157489
 pyfemtet/opt/advanced_samples/excel_ui/femtet-macro.xlsm,sha256=ckF0SQ0f3IWSW6QoH1IPJdwUUlR7O_AiGC5fi8SI3jA,133137
 pyfemtet/opt/advanced_samples/excel_ui/pyfemtet-core.py,sha256=aF2TWXdbt7dnkeBqqVO6GvIExozjFp0mxx3BX8rpYNc,9879
 pyfemtet/opt/advanced_samples/excel_ui/test-pyfemtet-core.cmd,sha256=r-Pa1Ng9sa6wfDqIhTf2BUDrN9rePWFymz7pmtBbvcQ,895
+pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric.femprj,sha256=iIHH1X-wWBqEYj4cFJXco73LCJXSrYBsSKOD0HxYu60,87599
+pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart.py,sha256=YCqtLjazFDRKhEu7sGJlDJDDL7YPH6GmWEb6X0e30Og,3045
+pyfemtet/opt/advanced_samples/restart/gal_ex13_parametric_restart_jp.py,sha256=Oaua2Eb8NGtlWjvYC9B1uYTKcEuWxWZxzJbLi_4IqxE,3580
 pyfemtet/opt/advanced_samples/surrogate_model/gal_ex13_create_training_data.py,sha256=tgNH0z-mUZRq-3VLjR-BU09z2COmXFruyrc4T8WS5U8,1663
 pyfemtet/opt/advanced_samples/surrogate_model/gal_ex13_create_training_data_jp.py,sha256=xtfJWrc353k1977wIf66MOPmgqLDDQpMCtX8QSDE5zQ,1813
 pyfemtet/opt/advanced_samples/surrogate_model/gal_ex13_optimize_with_surrogate.py,sha256=s0b31wuN3iXjb78dt0ro0ZjxHa8uLIH94jRfEuj1EVY,3090
@@ -42,22 +45,22 @@ pyfemtet/opt/advanced_samples/surrogate_model/gal_ex13_parametric.femprj,sha256=
 pyfemtet/opt/interface/__init__.py,sha256=na6-elI9-karOqoSxT9LfLQpjBPm1lrUWjow0NYYRP4,1349
 pyfemtet/opt/interface/_base.py,sha256=y0uQ5jdsWbgt5odyqPin7NXcK_IbUwPDcrrkV_JhpRw,2722
 pyfemtet/opt/interface/_excel_interface.py,sha256=s103vePTPXXYiPwGdAEUFgtpvGXtu1nSljDtP4HsmcY,40355
-pyfemtet/opt/interface/_femtet.py,sha256=Tn0qgVMJDv-6hBPDOWYBtlfvhsb4UH3MknX0PaXb8ro,35313
+pyfemtet/opt/interface/_femtet.py,sha256=_T75D0GWEYc_5n9RRF6u-HZVxgFnG9PoGYF2-cDiqeM,37673
 pyfemtet/opt/interface/_femtet_parametric.py,sha256=rhvnpHdbjNJAKxiCkgnExnZdV5qOB6pBv6AaLeTkeF8,10155
 pyfemtet/opt/interface/_femtet_with_nx/__init__.py,sha256=-6W2g2FDEcKzGHmI5KAKQe-4U5jDpMj0CXuma-GZca0,83
 pyfemtet/opt/interface/_femtet_with_nx/_interface.py,sha256=LkaODUSpBLq05uz5Jf-JKuH6Evq8ElZoItXxFZopWeM,5994
 pyfemtet/opt/interface/_femtet_with_nx/update_model.py,sha256=P7VH0i_o-X9OUe6AGaLF1fACPeHNrMjcrOBCA3MMrI4,3092
 pyfemtet/opt/interface/_femtet_with_sldworks.py,sha256=rjEgebuP1w1eAFVWw4eRJUq3lsyBcmXlkMjZKIpD0kw,11019
 pyfemtet/opt/interface/_surrogate/__init__.py,sha256=2UT5NuBylyWQJNjg1zsBRCV-MzNCUswTUt6ZuSrYFUM,120
-pyfemtet/opt/interface/_surrogate/_base.py,sha256=bQMoztVq1b-3BW5Z1V-dSROplMHutrblDI289j0cC-E,3001
-pyfemtet/opt/interface/_surrogate/_chaospy.py,sha256=gL72bCgs1AY_EZdJtcifSC-apwsZzp4zsWYxcpVKvtw,1969
-pyfemtet/opt/interface/_surrogate/_singletaskgp.py,sha256=ojZHsxGxSc8ZJqJQ_uMHvpK98TPUsHzXP0q4tmM0YPQ,2471
+pyfemtet/opt/interface/_surrogate/_base.py,sha256=_mVjoxrGEWL-PydjzEYXIgsOJ9zPmntoRHY3dXR2HGo,3098
+pyfemtet/opt/interface/_surrogate/_chaospy.py,sha256=Bqej89Mo0zgdJq1OK7YKRqHOcuyN0wL4ZQUQXdJtYJ8,1987
+pyfemtet/opt/interface/_surrogate/_singletaskgp.py,sha256=bHzY5QIjA9zhLxweexz259XQMZLgkHWfrIDW7f3q-2k,2520
 pyfemtet/opt/optimizer/__init__.py,sha256=Ia6viowECkG0IFXtFef0tJ4jDKsoDzJLqMJ9xLFH2LQ,543
-pyfemtet/opt/optimizer/_base.py,sha256=j8aQc3fGehZTJT9ETf9cr3VWYs2FYk1F8fO3f7QyKAU,13099
+pyfemtet/opt/optimizer/_base.py,sha256=1TY1iVZdpgJcmF6g3-CcY-6u4REs8_gR_0y9cXUQe2s,12932
 pyfemtet/opt/optimizer/_optuna/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyfemtet/opt/optimizer/_optuna/_botorch_patch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyfemtet/opt/optimizer/_optuna/_botorch_patch/enable_nonlinear_constraint.py,sha256=b2-PP2HM46kJS4cJkBWnxnW9AS9JfeVkEjmkoKK_ziE,8949
-pyfemtet/opt/optimizer/_optuna/_optuna.py,sha256=5Bjn8LrWpIFWH3lRq6Ke5XYzKQNwoGWNHz59HNMEALA,17093
+pyfemtet/opt/optimizer/_optuna/_optuna.py,sha256=5W_Z9p6lPVeflttx0fpRryic_fUVKl0lz6tqkxUpCnA,17422
 pyfemtet/opt/optimizer/_optuna/_pof_botorch.py,sha256=FLx9p6IH8xcZl_SZYvs8grMqLEidj5YaBD8urDD88Pk,73768
 pyfemtet/opt/optimizer/_scipy.py,sha256=_2whhMNq6hC1lr5PlYhpZ8Zlh6-DkAjz8SVB5qHIpYg,4766
 pyfemtet/opt/optimizer/_scipy_scalar.py,sha256=rGvrLjrgfYzxK9GA0-r2Hhoaqt6A0TQsT_1M3moyklc,3615
@@ -85,6 +88,8 @@ pyfemtet/opt/samples/femprj_sample/gal_ex58_parametric_test_result.reccsv,sha256
 pyfemtet/opt/samples/femprj_sample/gau_ex08_parametric.femprj,sha256=Yb9ILeTEKx5xfJGk8IZH_DVlgkpGB33Vy9-LGIEQboY,279251
 pyfemtet/opt/samples/femprj_sample/gau_ex08_parametric.py,sha256=5KazqJ5wRbGs0dBMJslZ1eRCUWq8j3k1mqlhyB8M0g8,1929
 pyfemtet/opt/samples/femprj_sample/gau_ex08_parametric_test_result.reccsv,sha256=yZ9aHthiKIBY_NMOz94Jl2dyHIH-GWMvukgHk4ZeT_o,3474
+pyfemtet/opt/samples/femprj_sample/gau_ex12_parametric.femprj,sha256=cmuUgKtM3qoJrSxkWMZHVNdEgUFo7wFNO0vMkGCxl9k,461055
+pyfemtet/opt/samples/femprj_sample/gau_ex12_parametric.py,sha256=XYzMYQOq7O4wFgf9Diw_oKe7-kbGRFJBOWVg3e4O9io,1831
 pyfemtet/opt/samples/femprj_sample/her_ex40_parametric.femprj,sha256=LLAUDlUo1dIpRzlKPs1lvACzJQxjnWW3xAGAodYEqRM,117221
 pyfemtet/opt/samples/femprj_sample/her_ex40_parametric.py,sha256=ImxVoNHDywW77DX8pkHi08wPW7AlRUiaDBpUD3fPIRk,4848
 pyfemtet/opt/samples/femprj_sample/her_ex40_parametric_test_result.reccsv,sha256=0yWqTpmpAtFvYRRyk2zneAVnl_5qJDeVwG4aeIWxXv8,3679
@@ -107,6 +112,7 @@ pyfemtet/opt/samples/femprj_sample_jp/gal_ex58_parametric_jp.femprj,sha256=PzqtN
 pyfemtet/opt/samples/femprj_sample_jp/gal_ex58_parametric_jp.py,sha256=97np4uH-UQqpv4UDwJS0doFYA7TOkXnbhLdkZExdNek,2461
 pyfemtet/opt/samples/femprj_sample_jp/gau_ex08_parametric_jp.femprj,sha256=TTXw_8YT8pzHQlu4ufGzTq1IFYSwcWWt4GA6sIY1YPM,295600
 pyfemtet/opt/samples/femprj_sample_jp/gau_ex08_parametric_jp.py,sha256=8Op_zwz9SD0NfGg4TFlcNvs-ZlU0bxgs5oaaI9UtlRU,2087
+pyfemtet/opt/samples/femprj_sample_jp/gau_ex12_parametric_jp.py,sha256=VDujrSbAPANqlizugVJX27uyWnnnOjclv4NJAZXDSXc,1997
 pyfemtet/opt/samples/femprj_sample_jp/her_ex40_parametric_jp.femprj,sha256=OJ7f8iw0z1BZqanuNn71uEaoM2Kgb93ptUU8iYwYON0,129783
 pyfemtet/opt/samples/femprj_sample_jp/her_ex40_parametric_jp.py,sha256=MlFk6KRCQeCX1J0DNOjph75qjCUHg5UQPNTcHxIEnoo,5279
 pyfemtet/opt/samples/femprj_sample_jp/paswat_ex1_parametric_jp.femprj,sha256=y7eURFBdqh6PmD4zbelGuB458HmfihVht0K4wVI-mik,265368
@@ -137,8 +143,8 @@ pyfemtet/opt/visualization/result_viewer/.gitignore,sha256=ryvb4aqbbsHireHWlPQfx
 pyfemtet/opt/visualization/result_viewer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyfemtet/opt/visualization/result_viewer/application.py,sha256=WcHBx_J5eNLKSaprpk9BGifwhO04oN8FiNGYTWorrXA,1691
 pyfemtet/opt/visualization/result_viewer/pages.py,sha256=MZAjzbuq0toZrR-iJhElM3A12_jHVCTt65gz1kdNPbw,32193
-pyfemtet-0.8.7.dist-info/LICENSE,sha256=sVQBhyoglGJUu65-BP3iR6ujORI6YgEU2Qm-V4fGlOA,1485
-pyfemtet-0.8.7.dist-info/METADATA,sha256=uy1fm6IKQ5OXU8kZ7bowgMIyCbyaQ9NTgaxz0r1DoV0,3509
-pyfemtet-0.8.7.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pyfemtet-0.8.7.dist-info/entry_points.txt,sha256=ZfYqRaoiPtuWqFi2_msccyrVF0LurMn-IHlYamAegZo,104
-pyfemtet-0.8.7.dist-info/RECORD,,
+pyfemtet-0.8.9.dist-info/LICENSE,sha256=sVQBhyoglGJUu65-BP3iR6ujORI6YgEU2Qm-V4fGlOA,1485
+pyfemtet-0.8.9.dist-info/METADATA,sha256=7KhkJFd-xgckrqllScrrmO-uAYns2wfa-G8PDR5KSd8,3509
+pyfemtet-0.8.9.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pyfemtet-0.8.9.dist-info/entry_points.txt,sha256=ZfYqRaoiPtuWqFi2_msccyrVF0LurMn-IHlYamAegZo,104
+pyfemtet-0.8.9.dist-info/RECORD,,