pyfemtet 0.4.20__py3-none-any.whl → 0.4.21__py3-none-any.whl

pyfemtet/message/locales/messages.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2024-07-23 15:23+0900\n"
+"POT-Creation-Date: 2024-08-20 10:15+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -57,383 +57,391 @@ msgstr ""
 msgid "Optimization finished. Results were saved in following:"
 msgstr ""
 
-#: pyfemtet/message/messages.py:55
+#: pyfemtet/message/messages.py:53
+msgid "No bounds specified."
+msgstr ""
+
+#: pyfemtet/message/messages.py:54
+msgid "The optimization is now complete. You can view the results on the monitor until you press Enter to exit the program."
+msgstr ""
+
+#: pyfemtet/message/messages.py:57
 msgid "\"%UGII_BASE_DIR%\\NXBIN\\run_journal.exe\" is not found. Make sure you have NX installed and the environment variable UGII_BASE_DIR is set."
 msgstr ""
 
-#: pyfemtet/message/messages.py:56
+#: pyfemtet/message/messages.py:58
 msgid "Model reconstruction failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:57
+#: pyfemtet/message/messages.py:59
 msgid "Model update failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:58
+#: pyfemtet/message/messages.py:60
 msgid "It was detected that the configuration of Femtet python macro constants has not been completed. The configuration was done automatically (python -m win32com.client.makepy FemtetMacro). Please restart the program."
 msgstr ""
 
-#: pyfemtet/message/messages.py:59
+#: pyfemtet/message/messages.py:61
 msgid "Failed to connect to Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:60
+#: pyfemtet/message/messages.py:62
 msgid "The Femtet process crashed and could not be restarted successfully."
 msgstr ""
 
-#: pyfemtet/message/messages.py:61
+#: pyfemtet/message/messages.py:63
 msgid "An abnormal termination of the Femtet process has been detected. Recovery will be attempted."
 msgstr ""
 
-#: pyfemtet/message/messages.py:62
+#: pyfemtet/message/messages.py:64
 msgid "Femtet has been restarted and will perform analysis and attempt to recover."
 msgstr ""
 
-#: pyfemtet/message/messages.py:63
+#: pyfemtet/message/messages.py:65
 msgid "If you specify 'new' as the 'connect_method' argument, set the 'femprj_path' argument to existing femprj file path."
 msgstr ""
 
-#: pyfemtet/message/messages.py:64
+#: pyfemtet/message/messages.py:66
 msgid "The specified variable is not included in the Femtet analysis model. Note the capitalization of the variable."
 msgstr ""
 
-#: pyfemtet/message/messages.py:65
+#: pyfemtet/message/messages.py:67
 msgid "The following APIs are not accessible: "
 msgstr ""
 
-#: pyfemtet/message/messages.py:66
+#: pyfemtet/message/messages.py:68
 msgid "Macros may not be enabled in the installed version of Femtet. Please run the \"Enable Macros\" command from the start menu with administrator privileges in the same version of Femtet that is installed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:67
+#: pyfemtet/message/messages.py:69
 msgid "No analysis model is open"
 msgstr ""
 
-#: pyfemtet/message/messages.py:68
+#: pyfemtet/message/messages.py:70
 msgid "The analysis model does not contain any variables."
 msgstr ""
 
-#: pyfemtet/message/messages.py:69
+#: pyfemtet/message/messages.py:71
 msgid "Failed to update variables:"
 msgstr ""
 
-#: pyfemtet/message/messages.py:70
+#: pyfemtet/message/messages.py:72
 msgid "The specified variable is not included in the analysis model and will be ignored."
 msgstr ""
 
-#: pyfemtet/message/messages.py:71
+#: pyfemtet/message/messages.py:73
 msgid "Model history re-execute failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:72
+#: pyfemtet/message/messages.py:74
 msgid "Model redraw failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:73
+#: pyfemtet/message/messages.py:75
 msgid "Mesh generation failed"
 msgstr ""
 
-#: pyfemtet/message/messages.py:74
+#: pyfemtet/message/messages.py:76
 msgid "Parametric solve failed"
 msgstr ""
 
-#: pyfemtet/message/messages.py:75
+#: pyfemtet/message/messages.py:77
 msgid "Solve failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:76
+#: pyfemtet/message/messages.py:78
 msgid "Open result failed."
 msgstr ""
 
-#: pyfemtet/message/messages.py:77
+#: pyfemtet/message/messages.py:79
 msgid "Failed to close Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:78
+#: pyfemtet/message/messages.py:80
 msgid "Failed to save result (.pdt) file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:79
+#: pyfemtet/message/messages.py:81
 msgid "Failed to save screenshot (.jpg)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:80
+#: pyfemtet/message/messages.py:82
 msgid "Screenshot (.jpg) is not found."
 msgstr ""
 
-#: pyfemtet/message/messages.py:81
+#: pyfemtet/message/messages.py:83
 msgid "Failed to update model in solidworks."
 msgstr ""
 
-#: pyfemtet/message/messages.py:84
+#: pyfemtet/message/messages.py:86
 msgid "The following features are not supported by the specified optimization method. "
 msgstr ""
 
-#: pyfemtet/message/messages.py:85
+#: pyfemtet/message/messages.py:87
 msgid "The parameter set does not match the one added with add_init_parameter."
 msgstr ""
 
-#: pyfemtet/message/messages.py:86
+#: pyfemtet/message/messages.py:88
 msgid "An exception has occurred during FEM update. Current parameters are: "
 msgstr ""
 
-#: pyfemtet/message/messages.py:87
+#: pyfemtet/message/messages.py:89
 msgid "The constraints were not satisfied for the following sets of variables:"
 msgstr ""
 
-#: pyfemtet/message/messages.py:88
+#: pyfemtet/message/messages.py:90
 msgid "Current parameter set cannot update FEM and this optimization method cannot skip current parameter set. The optimization process will be terminated."
 msgstr ""
 
-#: pyfemtet/message/messages.py:89
+#: pyfemtet/message/messages.py:91
 msgid "Optimization has been interrupted. Note that you cannot acquire the OptimizationResult in case of `trust-constr`, `TNC`, `SLSQP` or `COBYLA`."
 msgstr ""
 
-#: pyfemtet/message/messages.py:93
+#: pyfemtet/message/messages.py:95
 msgid "Connect to Femtet"
 msgstr ""
 
-#: pyfemtet/message/messages.py:94
+#: pyfemtet/message/messages.py:96
 msgid "Analysis model name described in csv does not exist in project."
 msgstr ""
 
-#: pyfemtet/message/messages.py:95
+#: pyfemtet/message/messages.py:97
 msgid "History csv is not read yet. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:96
+#: pyfemtet/message/messages.py:98
 msgid "Cannot read project data from csv. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:97
+#: pyfemtet/message/messages.py:99
 msgid ".femprj file described in csv is not found. Open your project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:98
+#: pyfemtet/message/messages.py:100
 msgid "Analysis model name is not specified. Open your model in the project manually."
 msgstr ""
 
-#: pyfemtet/message/messages.py:100
+#: pyfemtet/message/messages.py:102
 msgid "Constraint"
 msgstr ""
 
-#: pyfemtet/message/messages.py:101
+#: pyfemtet/message/messages.py:103
 msgid "feasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:102
+#: pyfemtet/message/messages.py:104
 msgid "infeasible"
 msgstr ""
 
-#: pyfemtet/message/messages.py:103
+#: pyfemtet/message/messages.py:105
 msgid "Optimality"
 msgstr ""
 
-#: pyfemtet/message/messages.py:104
+#: pyfemtet/message/messages.py:106
 msgid "non dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:105
+#: pyfemtet/message/messages.py:107
 msgid "dominated"
 msgstr ""
 
-#: pyfemtet/message/messages.py:106
+#: pyfemtet/message/messages.py:108
 msgid "Hypervolume Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:107
+#: pyfemtet/message/messages.py:109
 msgid "Objective Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:108
+#: pyfemtet/message/messages.py:110
 msgid "Multi Objective Pair Plot"
 msgstr ""
 
-#: pyfemtet/message/messages.py:109
+#: pyfemtet/message/messages.py:111
 msgid "trial number"
 msgstr ""
 
-#: pyfemtet/message/messages.py:111
+#: pyfemtet/message/messages.py:113
 msgid "Objectives"
 msgstr ""
 
-#: pyfemtet/message/messages.py:113
+#: pyfemtet/message/messages.py:115
 msgid "Prediction Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:114
+#: pyfemtet/message/messages.py:116
 msgid " Recalculate Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:115
+#: pyfemtet/message/messages.py:117
 msgid " Redraw graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:116
+#: pyfemtet/message/messages.py:118
 msgid "Parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:117
+#: pyfemtet/message/messages.py:119
 msgid "Parameter2"
 msgstr ""
 
-#: pyfemtet/message/messages.py:118
+#: pyfemtet/message/messages.py:120
 msgid "Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:119
+#: pyfemtet/message/messages.py:121
 msgid "No history selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:120
+#: pyfemtet/message/messages.py:122
 msgid "No FEM result (yet)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:121
+#: pyfemtet/message/messages.py:123
 msgid "Prediction model is not calculated yet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:122
+#: pyfemtet/message/messages.py:124
 msgid "Cannot select same parameter"
 msgstr ""
 
-#: pyfemtet/message/messages.py:124
+#: pyfemtet/message/messages.py:126
 msgid "Prediction Model of Objective"
 msgstr ""
 
-#: pyfemtet/message/messages.py:125
+#: pyfemtet/message/messages.py:127
 msgid "prediction model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:126
+#: pyfemtet/message/messages.py:128
 msgid "std. dev. of model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:128
+#: pyfemtet/message/messages.py:130
 msgid "Progress"
 msgstr ""
 
-#: pyfemtet/message/messages.py:129
+#: pyfemtet/message/messages.py:131
 msgid "Prediction"
 msgstr ""
 
-#: pyfemtet/message/messages.py:130
+#: pyfemtet/message/messages.py:132
 msgid "Workers"
 msgstr ""
 
-#: pyfemtet/message/messages.py:132
+#: pyfemtet/message/messages.py:134
 msgid "Optimization status will be shown here."
 msgstr ""
 
-#: pyfemtet/message/messages.py:133
+#: pyfemtet/message/messages.py:135
 msgid "Auto-update graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:134
+#: pyfemtet/message/messages.py:136
 msgid "Interrupt Optimization"
 msgstr ""
 
-#: pyfemtet/message/messages.py:136
+#: pyfemtet/message/messages.py:138
 msgid "Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:138
+#: pyfemtet/message/messages.py:140
 msgid "Open Result in Femtet"
 msgstr ""
 
-#: pyfemtet/message/messages.py:139
+#: pyfemtet/message/messages.py:141
 msgid "Reconstruct Model"
 msgstr ""
 
-#: pyfemtet/message/messages.py:140
+#: pyfemtet/message/messages.py:142
 msgid "Drag and drop or select csv file"
 msgstr ""
 
-#: pyfemtet/message/messages.py:141
+#: pyfemtet/message/messages.py:143
 msgid "Connection to Femtet is not established. Launch Femtet and Open a project."
 msgstr ""
 
-#: pyfemtet/message/messages.py:142
+#: pyfemtet/message/messages.py:144
 msgid "No result plot is selected."
 msgstr ""
 
-#: pyfemtet/message/messages.py:143
+#: pyfemtet/message/messages.py:145
 msgid "The femprj file path in the history csv is not found or valid."
 msgstr ""
 
-#: pyfemtet/message/messages.py:144
+#: pyfemtet/message/messages.py:146
 msgid "The model name in the history csv is not found."
 msgstr ""
 
-#: pyfemtet/message/messages.py:145
+#: pyfemtet/message/messages.py:147
 msgid ".pdt file is not found. Please check the .Results folder. Note that .pdt file save mode depends on the `save_pdt` argument of FemtetInterface in optimization script(default to `all`)."
 msgstr ""
 
-#: pyfemtet/message/messages.py:150
+#: pyfemtet/message/messages.py:152
 msgid "Failed to open "
 msgstr ""
 
-#: pyfemtet/message/messages.py:151
+#: pyfemtet/message/messages.py:153
 msgid "Specified model is not in current project. Please check opened project. For example, not \"analysis model only\" but your .femprj file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:154
+#: pyfemtet/message/messages.py:156
 msgid ".femprj file path of the history csv is invalid. Please certify matching between csv and opening .femprj file."
 msgstr ""
 
-#: pyfemtet/message/messages.py:155
+#: pyfemtet/message/messages.py:157
 msgid "Analysis model name of the history csv is invalid. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/message/messages.py:156
+#: pyfemtet/message/messages.py:158
 msgid "Analysis model name of the history csv and opened in Femtet is inconsistent. Please certify matching between csv and opening analysis model."
 msgstr ""
 
-#: pyfemtet/message/messages.py:157
+#: pyfemtet/message/messages.py:159
 msgid "tutorial mode"
 msgstr ""
 
-#: pyfemtet/message/messages.py:158
+#: pyfemtet/message/messages.py:160
 msgid "Load Sample CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:159
+#: pyfemtet/message/messages.py:161
 msgid "Load CSV"
 msgstr ""
 
-#: pyfemtet/message/messages.py:160
+#: pyfemtet/message/messages.py:162
 msgid "Open your optimization result. Then connecting to femtet will start automatically. Note that in tutorial mode, this button loads the ready-made sample csv and open sample femprj."
 msgstr ""
 
-#: pyfemtet/message/messages.py:162
+#: pyfemtet/message/messages.py:164
 msgid "Main Graph"
 msgstr ""
 
-#: pyfemtet/message/messages.py:163
+#: pyfemtet/message/messages.py:165
 msgid "Here the optimization history is shown. Each plot represents single FEM result. You can pick a result to open the corresponding result in Femtet. "
 msgstr ""
 
-#: pyfemtet/message/messages.py:166
+#: pyfemtet/message/messages.py:168
 msgid "Open Result"
 msgstr ""
 
-#: pyfemtet/message/messages.py:167
+#: pyfemtet/message/messages.py:169
 msgid "After pick a point in the main graph, This button shows the corresponding FEM result in Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:169
+#: pyfemtet/message/messages.py:171
 msgid "Re-connect to Femtet."
 msgstr ""
 
-#: pyfemtet/message/messages.py:170
+#: pyfemtet/message/messages.py:172
 msgid "Sample csv is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/message/messages.py:171
+#: pyfemtet/message/messages.py:173
 msgid "Sample femprj file is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 
-#: pyfemtet/message/messages.py:172
+#: pyfemtet/message/messages.py:174
 msgid "Sample femprj result folder is not found. Please consider to re-install pyfemtet by `py -m pip install pyfemtet -U --force-reinstall`"
 msgstr ""
 

pyfemtet/opt/_femopt.py

@@ -1,4 +1,5 @@
 # built-in
+from typing import Optional, Any, Callable
 import os
 import datetime
 from time import time, sleep
@@ -24,6 +25,7 @@ from pyfemtet.opt._femopt_core import (
     logger,
 )
 from pyfemtet.message import Msg, encoding
+from pyfemtet.opt.parameter import Parameter, Expression
 
 
 class FEMOpt:
@@ -109,7 +111,8 @@ class FEMOpt:
             lower_bound: float or None = None,
             upper_bound: float or None = None,
             step: float or None = None,
-            memo: str = ''
+            properties: Optional[dict] = None,
+            pass_to_fem: Optional[bool] = True,
     ):
         """Adds a parameter to the optimization problem.
 
@@ -119,34 +122,63 @@ class FEMOpt:
             lower_bound (float or None, optional): The lower bound of the parameter. Defaults to None. However, this argument is required for some algorithms.
             upper_bound (float or None, optional): The upper bound of the parameter. Defaults to None. However, this argument is required for some algorithms.
             step (float or None, optional): The step of parameter. Defaults to None.
-            memo (str, optional): Additional information about the parameter. Defaults to ''.
+            properties (dict, optional): Additional information about the parameter. Defaults to None.
+            pass_to_fem (bool, optional): If this variable is used directly in FEM model update or not. If False, this parameter can be just used as inpt of expressions. Defaults to True.
         Raises:
             ValueError: If initial_value is not specified and the value for the given name is also not specified.
 
         """
 
         _check_bound(lower_bound, upper_bound, name)
-        value = self.fem.check_param_value(name)
-        if initial_value is None:
-            if value is not None:
-                initial_value = value
-            else:
-                raise ValueError('initial_value を指定してください.')
 
-        d = {
-            'name': name,
-            'value': float(initial_value),
-            'lb': float(lower_bound) if lower_bound is not None else None,
-            'ub': float(upper_bound) if upper_bound is not None else None,
-            'step': float(step) if step is not None else None,
-            'memo': memo,
-        }
-        pdf = pd.DataFrame(d, index=[0], dtype=object)
-
-        if len(self.opt.parameters) == 0:
-            self.opt.parameters = pdf
+        if pass_to_fem:
+            value = self.fem.check_param_value(name)
+            if initial_value is None:
+                if value is not None:
+                    initial_value = value
+                else:
+                    raise ValueError('initial_value を指定してください.')
         else:
-            self.opt.parameters = pd.concat([self.opt.parameters, pdf], ignore_index=True)
+            if initial_value is None:
+                raise ValueError('initial_value を指定してください.')
+
+        prm = Parameter(
+            name=name,
+            value=float(initial_value),
+            lower_bound=float(lower_bound) if lower_bound is not None else None,
+            upper_bound=float(upper_bound) if upper_bound is not None else None,
+            step=float(step) if step is not None else None,
+            pass_to_fem=pass_to_fem,
+            properties=properties,
+        )
+        self.opt.variables.add_parameter(prm)
+
+    def add_expression(
+            self,
+            name: str,
+            fun: Callable[[Any], float],
+            properties=property,
+            kwargs: Optional[dict] = None,
+            pass_to_fem=True,
+    ):
+        """Add expression to the optimization problem.
+
+        Args:
+            name (str): The name of the variable.
+            fun (Callable[[Any], float]): An expression function. The arguments that you want to use as input variables must be the same with ``name`` of Variable objects added by ``add_parameter()`` or ``add_expression()``. If you use other objects as argument of the function, you must specify ``kwargs``.
+            properties ([type], optional): Property names and their values of the variable. Defaults to property.
+            kwargs (Optional[dict], optional): Remaining arguments of ``fun``. Defaults to None.
+            pass_to_fem (bool, optional): If this variable is used directly in FEM model update or not. If False, this variable can be just used as inpt of other expressions. Defaults to True.
+        """
+        exp = Expression(
+            name=name,
+            value=None,
+            properties=properties,
+            fun=fun,
+            kwargs=kwargs if kwargs else {},
+            pass_to_fem=pass_to_fem,
+        )
+        self.opt.variables.add_expression(exp)
 
     def add_objective(
             self,
@@ -250,20 +282,8 @@ class FEMOpt:
 
         self.opt.constraints[name] = Constraint(fun, name, lower_bound, upper_bound, strict, args, kwargs)
 
-    def get_parameter(self, format='dict') -> pd.DataFrame or dict or np.ndarray:
-        """Returns the parameter in a specified format.
-
-        Args:
-            format (str, optional): The desired output format. Defaults to 'dict'. Valid formats are 'values', 'df' and 'dict'.
-
-        Returns:
-            pd.DataFrame or dict or np.ndarray: The parameter data converted into the specified format.
-
-        Raises:
-            ValueError: If an invalid format is provided.
-
-        """
-        return self.opt.get_parameter(format)
+    def get_parameter(self, format='dict'):
+        raise DeprecationWarning('FEMOpt.get_parameter() was deprecated. Use Femopt.opt.get_parameter() instead.')
 
     def set_monitor_host(self, host=None, port=None):
         """Sets up the monitor server with the specified host and port.
@@ -338,8 +358,9 @@ class FEMOpt:
             self.opt.method_checker.check_seed()
 
         is_incomplete_bounds = False
-        for _, row in self.opt.parameters.iterrows():
-            lb, ub = row['lb'], row['ub']
+        prm: Parameter = None
+        for prm in self.opt.variables.parameters.values():
+            lb, ub = prm.lower_bound, prm.upper_bound
             is_incomplete_bounds = is_incomplete_bounds + (lb is None) + (ub is None)
         if is_incomplete_bounds:
             self.opt.method_checker.check_incomplete_bounds()
@@ -348,6 +369,10 @@ class FEMOpt:
         self.opt.n_trials = n_trials
         self.opt.timeout = timeout
 
+        # resolve expression dependencies
+        self.opt.variables.resolve()
+        self.opt.variables.evaluate()
+
         # クラスターの設定
         self.opt.is_cluster = self.scheduler_address is not None
         if self.opt.is_cluster:
@@ -427,7 +452,7 @@ class FEMOpt:
         self.status.set(OptimizationStatus.SETTING_UP)
         self.history = History(
             self.history_path,
-            self.opt.parameters['name'].to_list(),
+            self.opt.variables.get_parameter_names(),
             list(self.opt.objectives.keys()),
             list(self.opt.constraints.keys()),
             self.client,

pyfemtet/opt/_femopt_core.py

@@ -569,8 +569,8 @@ class History:
         # parameters
         for i, _row in parameters.iterrows():
             row.append(_row['value'])
-            row.append(_row['lb'])
-            row.append(_row['ub'])
+            row.append(_row['lower_bound'])
+            row.append(_row['upper_bound'])
 
         # objectives and their direction
         for (_, obj), obj_value in zip(objectives.items(), obj_values):  # objectives, direction