TC‑Python Property Model Examples

File name: pyex_PM_01_Property_model_interfacial_energy.py

This example shows how to run a (Jython) property model from TC-Python to calculate the interfacial energy. The Thermo-Calc Property Model uses a broken-bond approach. Any other pre-installed or user-defined Property Model created in Thermo-Calc can be loaded and used in the same way as in this example.

The details of a property model (arguments, result quantities, and so forth) are defined in the Thermo-Calc Property Model and are not known to TC-Python in advance. Therefore, when using the TC-Python property models, the workflow differs compared to other TC-Python modules. The available arguments need to be queried by using the respective `get_...()`- method. This requires some interactive development style until a first working version of the code is set up.

When TC-Python refers to the term "arguments", in the Property Model Development Framework it refers to "UI Panel Components". This refers to the same elements of the property model but differ in the same because TC-Python does not have a user interface (UI).

Output after calculating interfacial energy with a Property Model.

File name: pyex_PM_02_Property_model_parameter_fitting.py

This example shows how to optimize the parameters of a (Jython) property model. Typically this approach is used in order to fit a property model to experimental data. That can be useful for any application where no analytical correlation between the input parameters (composition, temperature and other parameters) and the material property can be established.

Examples might be solid solution strength models or martensite temperature models where the transformation barrier is modeled.

For the purpose of this example, the linear fitting to noisy data is shown.

A 'model parameter' is a value that can be changed from the outside of the model in the way demonstrated here. Internally it can be represented in any way; the only requirement is that the property model implements the 'Python Property Model Development Framework' interface methods :func:`provide_model_parameters()` and :func:`set_model_parameter()`.

Fitting of a linear Property Model.

File name: pyex_PM_03_Property_model_self_developed_model.py

This example shows how to develop and run your own Property Model. An example model is provided in the folder property_models/FreezeInEquilibriumPython. It is a simplified version of the FreezeInEquilibrium model that is installed with Thermo-Calc. Run this script to use the example model.

Any changes made to the main model file (FreezeInEquilibriumPythonModel.py), takes effect the next time you run this script.

File name: pyex_PM_04_Property_model_YS_simplified_mode_vs_advanced_mode.py

This example shows how to call the Yield Strength model using the Simplified and Advanced modes.

It is based on the Graphical Mode example "PM_G_04_Yield_Strength", which is included with the Thermo-Calc installation.

Comparing the total precipitation strengthening to particle radius for the Advanced and Simplified modes used with the Yield Strength Property Model.

File name: pyex_PM_05_Property_model_equilibrium_with_freeze_in_temperature.py

This example demonstrates how to call the Freeze-in Temperature Equilibrium Property Model using TC-Python.

This example is not available with TC-Toolbox for MATLAB®.

The Freeze-in Temperature Equilibrium Property Model calculates the equilibrium material state at the specified "freeze-in" temperature, and evaluates material properties at the specified system temperature. The assumption used for this model is that diffusion and phase transformations are negligible for a material when below the freeze-in temperature and therefore, the material state is kept constant for system temperatures below the freeze-in temperature.

The TCS Al-based Alloy Database (TCAL) is used in this example. A valid license for version 7 (TCAL7) or newer is required to run the example.

If you do not have a license, it is suggested that you change the variable tdb to ALDEMO or other thermodynamic database of interest, and modify the dependent_element and key-value pairs in the 'composition' dict() to be compatible with the selected database.

This example also demonstrates how to collect and plot all output results of any Property Model using a dictionary. For additional information on this Property Model, in Thermo-Calc press F1 and search the help.

File name: pyex_PM_06_yield_strength_with_multiple_precipitates.py

This example shows how to invoke dynamic arguments (equivalent to clicking the add (+) button in the GUI) for a Property Model field that supports this. One common example is adding multiple precipitates to a yield strength calculation.

The TCS Al-based Alloy Database (TCAL) is used in this example. A valid license for version 7 (TCAL7) or newer is required to run the example.