The JMatPro® API (Application Programming Interface) can be used to incorporate specific functionality of the JMatPro® software into your own applications. We provide the basic building blocks for you to automate and develop tasks within your own models and to integrate them into your own software.
The JMatPro® API provides calculations for:
- Stable and metastable phase equilibria
- Physical and thermophysical properties
- Solidification phases and properties
- Mechanical properties for Al, Fe, Ni, Co and Ti alloys
For General Steels:
- Time-temperature transformation (TTT) diagrams
- Continuous cooling transformation (CCT) diagrams
For General Steels and Titanium alloys:
- Cooling properties in the solid state
Benefits of using the JMatPro® API
The JMatPro® API is a collection of functions, organised in several libraries written in C/C++, that allow you to integrate some of the functionality of JMatPro® into your own applications. It gives you the flexibility to write code tailored for your specific needs, including but not limited to:
- Development of custom models
- Task automation / batch data generation
- Creation of custom export files for third-party simulation software
- Streamlining materials / process simulation workflows
The API comes with thorough documentation and plenty of code samples to help you get started. A full Python wrapper and demo code are also available.
JMatPro® API reference guide
*If the API documentation does not open properly or if some of its content seems to be missing: right click on the chm file, select 'Properties', then click 'Unblock', press OK and try to open the chm file again*
- corrected typo in parameter for mechanical properties of some Aluminium alloys
- Implemented a back diffusion model for steels in the Solver and Solidification modules.
- Extended the Solidification module with a quench from back diffusion model for steels and titanium alloys, improved existing quench models, and implemented a variant of the quench from Scheil-Gulliver model for titanium alloys.
- Added specific heat and latent heat of formation for each of the austenite decomposition products to the output of a Solidification calculation using the quench from Scheil-Gulliver model for steels and white cast irons.
- Extended the Cooling module for titanium alloys.
- Extended high-temperature strength and flow stress calculations in the Mechanical module for general steels in the tempered condition.
- Improved calculation of latent heat of formation of ferrite from austenite.
- Reassessed creep for BCC phase in steels.
- Improved creep and rupture strength models for nickel-based alloys.
- Added new dislocation cutting mechanism in aluminium alloys kinetics.
- Remodelled age hardening for Al3Sc phase in aluminium alloys.
- Improved stability of the thermodynamic solver.
- Updated the thermodynamic and properties databases to match those included in JMatPro v14.0.
- Adjusted the Al thermodynamic database.
- Reassessed molar volume of Ti2Cu and Ti2Ni phases for titanium alloys.
- Fixed possible failure in aluminium strength calculations.
- Fixed possible failure in high-temperature strength calculations for general steels.
JMatPro® API v7.1, June 2022
Extended Mechanical module with the calculation of tempered hardness for general steels
Improved Cu effect in the mechanical properties of aluminium alloys
Improved assessment of kinetics for some phases of aluminium alloys
Completed and corrected physical properties for TIM_B2 phase of titanium alloys
Fixed Solidification calculations for aluminium alloys containing oxygen
Fixed a possible issue affecting Cooling calculations
Added full Python wrapper and sample code for all available modules
JMatPro® API v7.0, December 2021
Improved quench from Scheil-Gulliver solidification model for steels to deal with cases where austenite only appears in the solid state
Reassessed yield strength <-> tensile strength <-> hardness interconversions for steels
Extended Mechanical module for aluminium alloys, including the calculation of room-temperature and high-temperature strength, as well as flow stress and age hardening curves
Remodelled contribution of particles at grain boundaries to rupture life in Ni alloys
Improved calculation of the elastic limit (point of the stress-strain curve at 0 strain)
Moved jmpSetQuenchRate() to the Core module
Added function to toggle elastic region in flow stress curves on or off
Changed the strain rate decade subdivision method used in high-temperature strength and flow stress calculations to produce nicer values
Updated the thermodynamic and properties databases to match those included in JMatPro® v13.0
Added NIW and NI6SI2B phases to Ni thermodynamic database
Adjusted MC phase in Ni and Co thermodynamic databases
Added AL12MO phase to Al thermodynamic database
Added CLUSTER metastable phase to Al thermodynamic database
Adjusted MGRE12 phase in Mg thermodynamic database
Reassessed thermal conductivity contribution for Cu and Si in FCC phase
Reassessed thermal conductivity for magnesium alloys with significant Al content
Fixed bug in Cooling calculations occurring with some user-defined profiles
Fixed mismatching problems in Solidification calculations using the quench from Scheil-Gulliver model for steels or white cast irons with out-of-step austenitisation temperatures
Fixed missing reset in Solidification calculations using the quench from Scheil-Gulliver model for steels, which could lead to wrong behaviour for ferritic steels with secondary phases