CreateUserDefinedModel

Open topic with navigation

HFSS™ Scripting Guide

CreateUserDefinedModel

Creates a user-defined model.

Note: This option can be used to create a UDM from an imported CAD model (Modeler > Discovery Link).

UI Access Draw > User-Defined Model > [Model]

Parameters

Name	Type	Description
<Parameters>	Array	Structured array. ["NAME:UserDefinedModelParameters", <DefinitionArray>, <OptionsArray>, <GeometryParamsArray>, "DllName:=", <string filepath>, "Library:=", <string>, "Version:=", <string> "ConnectionID:=", <string>]
<DefinitionArray>	Array	Structured array containing string "NAME:Definition." It defines the Discovery model to be used for import.
<OptionsArray>	Array	Structured array containing string "NAME:Options." The inputs correspond to the parameters in the Options > 3D Modeler > Discovery Link window.
<GeometryParamsArray>	Array	Structured array containing arrays for individual parameters: ["NAME:GeometryParameters", ["NAME:UDMParam", "Name:=" , <string>, "Value:=" , <string>, "PropType2:=" , <integer>, "PropFlag2:=" , <integer>]] Required UDM parameters depend on the UDM being created. To see which properties apply to a UDM, right-click the UDM in the Project Tree and select Properties. Then select the Parameters tab. `PropType2` can be any of the following: 0 – Property takes a string value. 1 – Property is a menu option. 2 – Property takes a number (integer or double). 3 – Property takes a value (numbers, variables, or expressions). 4 – Property is a file name. 5 – Property corresponds to a check box. 6 – Property specifies a 3D position. `PropFlag2` can be any of the following: 0 – No flags 1 – Read-only 2 – Must be integer 4 – Must be real 8 – Hidden `PropFlag2` values can be combined. For example, a read-only property that must be an integer would take the value 3. A hidden property that must be real would take the value 12. These values are further described in the `UserDefinedPrimitiveStructures.h` file included with the installation under "...\ANSYS Inc\v261\AnsysEM\UserDefinedPrimitives\Examples\Headers"

Return Value None

Python Syntax	CreateUserDefinedModel(<Parameters>)
	Import a Unigraphics model: oEditor = oDesign.SetActiveEditor("3D Modeler") oEditor.CreateUserDefinedModel( ["NAME:UserDefinedModelParameters", ["NAME:Definition", ["NAME:UDMParam", "Name:=" , "GeometryFilePath", "Value:=" , "\"D:\\Temp\\model1.prt\"", ], ["NAME:UDMParam", "Name:=" , "ProcessID", "Value:=" , "50584", ], ["NAME:UDMParam", "Name:=" , "CAD Plug-In", "Value:=" , "\"Unigraphics\"", ] ] ])
	Import a Discovery model with Options set: oEditor = oDesign.SetActiveEditor("3D Modeler") oEditor.CreateUserDefinedModel( ["NAME:UserDefinedModelParameters", ["NAME:Definition", ["NAME:UDMParam", "Name:=" , "GeometryFilePath", "Value:=" , "\"D:/Designs/discovery_with_assembly 1.dsco\"", "DataType:=" , "String", "PropType2:=" , 0, "PropFlag2:=" , 0 ], ], ["NAME:Options", ["NAME:UDMParam", "Name:=" , "Solid Bodies", "Value:=" , "1", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Surface Bodies", "Value:=" , "1", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Named Selections", "Value:=" , "1", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Parameters", "Value:=" , "\"eCADImportParameterType_Independent,eCADImportParameterType_None,eCADImportParameterType_Independent,eCADImportParameterType_All\"", "DataType:=" , "String", "PropType2:=" , 1, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Parameter Key", "Value:=" , "\"\"", "DataType:=" , "String", "PropType2:=" , 0, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Materials", "Value:=" , "\"Assignments and Properties,None,Assignments,Assignments and Properties\"", "DataType:=" , "String", "PropType2:=" , 1, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Import As Lightweight", "Value:=" , "0", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 1 ], ["NAME:UDMParam", "Name:=" , "Facet Level", "Value:=" , "\"3,1,2,3,4,5\"", "DataType:=" , "String", "PropType2:=" , 1, "PropFlag2:=" , 1 ], [ "NAME:UDMParam", "Name:=" , "Cleaning", "Value:=" , "1", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 0 ], ["NAME:UDMParam", "Name:=" , "Create Groups for Sub assembly", "Value:=" , "1", "DataType:=" , "Int", "PropType2:=" , 5, "PropFlag2:=" , 0 ], ], ["NAME:GeometryParams" ], "DllName:=" , "SACADIntegUDM", "Library:=" , "installLib", "Version:=" , "1.0", "ConnectionID:=" , "" ])
Python Example	With GeometryParams set: oEditor.CreateUserDefinedModel( ["NAME:UserDefinedModelParameters", ["NAME:Definition"], ["NAME:Options"], ["NAME:GeometryParams", ["NAME:UDMParam", "Name:=" , "WaveguideRadius", "Value:=" , "5mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "WaveguideLength", "Value:=" , "10mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "FlareAngle", "Value:=" , "32deg", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "NumberOfNotches", "Value:=" , "12", "PropType2:=" , 3, "PropFlag2:=" , 2 ], ["NAME:UDMParam", "Name:=" , "WidthOfNotch", "Value:=" , "1mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "DepthOfNotch", "Value:=" , "2mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "WidthOfTooth", "Value:=" , "2mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ], ["NAME:UDMParam", "Name:=" , "WallThickness", "Value:=" , "2.5mm", "PropType2:=" , 3, "PropFlag2:=" , 4 ] ], "DllName:=" , "HFSS/Antenna Toolkit/Horn/Corrugated.py", "Library:=" , "syslib", "Version:=" , "1.1", "ConnectionID:=" , "" ])

Ansys Electromagnetics Suite 2026 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.