SimcenterKnowledge

Materials > Using custom materials > Simcenter Samcef user-defined material models

Simcenter Samcef UMAT XML file

The UMAT XML file contains the methods, properties, and so on that define:

  • The labels in the Material dialog box.

  • The format of the values entered in the Material dialog box and in user-defined material entries in the Simcenter Samcef input file.

The UMAT XML file must have a .umatx extension.

The Simcenter Samcef Document Type Definition (DTD) file

The Document Type Definition (DTD) file for the UMAT XML file resides in this software's installation structure as ..\ugii\materials\nxsamcef_umat.dtd. The DTD defines the building blocks of the UMAT XML file that you must provide. It defines the document structure with a list of legal elements and attributes. The DTD file contains documentation on its usage.

A basic example of a Simcenter Samcef UMAT XML file

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE UserMaterialModels SYSTEM "nxsamcef_umat.dtd"> <UserMaterialModels>      <UserMaterialModel modelType="&umatModel1;"                       lookupKey="ExamplePlasticityModel"                       KeyPosIntID="1"                       displayName="Traction with Bilinear Elastic Law"                          cardSpec="OVMB05"                        numStateVariables="0">          <ValidMaterial type="&MaterialTypeISOTROPICLookUp;"/>         <ValidMaterial type="&MaterialTypeORTHOTROPICLookUp;"/>         <ValidMaterial type="&MaterialTypeDAMAGEINTERFACELookUp;"/>         <CardPropertyMapping type="&real;"                             lookupKey="ElasticYoungModulus"/>                                  <CardPropertyMapping type="&real;"                             lookupKey="PlasticYoungModulus"/>                                                                                         <CardPropertyMapping type="&real;"                             lookupKey="UserPoissonRatio"/>         <CardPropertyMapping type="&real;"                             lookupKey="TransverseDeformation"/>  							         <Properties>            <Group label="Isotropic Properties">                <Property displayName="Elastic Young Modulus"                          lookupKey="ElasticYoungModulus"                          valueType="float"                          Dimensions="&MeasureStress;">                    <DefaultValue value="&valueEmpty;"/>                    <LowerBound value="&minFloat;"                                inclusive="true" />                    <UpperBound value="&maxFloat;"                                inclusive="true" />                             </Property>                <Property displayName="Plastic Young Modulus"                          lookupKey="PlasticYoungModulus"                          valueType="float"                          Dimensions="&MeasureStress;">                    <DefaultValue value="&valueEmpty;"/>                    <LowerBound value="&minFloat;"                                inclusive="true" />                    <UpperBound value="&maxFloat;"                                inclusive="true" />                             </Property>                <Property displayName="Poisson Ratio"                          lookupKey="UserPoissonRatio"                          valueType="float"                          Dimensions="&MeasureUnitLess;">                    <DefaultValue value="&valueEmpty;"/>                    <LowerBound value="-1"                                inclusive="true" />                    <UpperBound value="1"                                inclusive="true" />                             </Property>                <Property displayName="Transverse Deformation"                          lookupKey="TransverseDeformation"                          valueType="float"                          Dimensions="&MeasureStrain;">                    <DefaultValue value="&valueEmpty;"/>                    <LowerBound value="&minFloat;"                                inclusive="true" />                    <UpperBound value="&maxFloat;"                                inclusive="true" />                             </Property>           </Group>				        </Properties>    </UserMaterialModel> </UserMaterialModels>

Description of some important XML entries in that example

  • The !DOCTYPE entry defines the DTD file used to define the vocabulary of the XML file.

  • In the UserMaterialModel definition header, the KeyPosIntID="1" and lookupKey="ExamplePlasticityModel" entries uniquely identify your material. Both these keywords must be unique among all the user-defined materials you define in all the .umatx files that you build.

  • The displayName entry defines the name that will appear in the dialog box.

  • The cardSpec="OVMB05" entry identifies the name of the specialized routine that will parse and analyze this material in the compiled dll file.For more information, see Simcenter Samcef UMAT subroutine.

  • The numStateVariables is a reserved keyword that must be remain equal to 0.

  •         The ValidMaterial define in which type of classical materials your user-defined material will appear in. In Pre/Post, your user-defined material model properties appear in the materials dialog boxes on a page named User Models - Simcenter Samcef.In this example, the User Models - Simcenter Samcef material page will appear in the Isotropic, Orthotropic, and Damage Interface materials of the materials library.

  •                              ... the CardPropertyMapping entry references a lookupKey entry in the Properties section of the material.The order of these entries sets the order of the USER values in the Simcenter Samcef user material definition in the input file. For more information, see the Samcef UMAT material page in the Simcenter Samcef documentation.

  • The Group entry groups several properties.

  • The Property classically defines the material properties.All the properties must be referenced by the lookupKey keyword of the CardPropertyMapping entries.

Location of the .umatx files

You can define several UMAT XML files.

For Pre/Post, programmer or site administrator uploads these files to the software startup location.

You must upload all your .umatx to this location.

The startup location can be any of the following:

  • UGII_USER_DIR\startup

  • UGII_SITE_DIR\startup

  • UGII_VENDOR_DIR\startup

A full example of a Simcenter Samcef UMAT XML file

Download the example .

Learn more

Simcenter Samcef user-defined materials overview

Simcenter Samcef UMAT workflow

Simcenter Samcef UMAT subroutine

Compiling the Simcenter Samcef UMAT subroutine

Prerequisites for Simcenter Samcef user-defined materials

Simcenter Samcef UMAT troubleshooting

Simcenter Samcef UMAT output requests and results

Simcenter Samcef UMAT export

Import of a Simcenter Samcef UMAT material

Define a Simcenter Samcef UMAT material

Quick links

Command reference

Pre/Post video examples

Bulk Entry Descriptions

Simcenter 3D tutorials

Browse Simcenter 3D help by product area

Simcenter Samcef UMAT XML file, Simcenter 3D 2021.1 Series

© 2020 Siemens

window.mainLanguage="en_US"

window.delivId=""

window.projectId=""

MathJax.Hub.Config({ TeX: { extensions: ["autoload-all.js"] }, tex2jax: { displayMath: [ ] }, "SVG": { scale: 125 } });

Source: https://docs.sw.siemens.com/en-US/doc/289054037/PL20200601120302950.advanced/xid1665699 · retrieved 2026-07-17