## On this page

  

 

 # `ModelImport`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.ModelImport"></a>

#### *class* Ansys.ACT.Automation.Mechanical.ModelImport

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a ModelImport.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#ModelImport.Activate)Activate the current object.[`AddComment`](#ModelImport.AddComment)Creates a new child Comment.[`AddFigure`](#ModelImport.AddFigure)Creates a new child Figure.[`AddImage`](#ModelImport.AddImage)Creates a new child Image.[`CopyTo`](#ModelImport.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#ModelImport.CreateParameter)Creates a new parameter for a Property.[`Duplicate`](#ModelImport.Duplicate)Creates a copy of the current DataModelObject.[`GetChildren`](#ModelImport.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#ModelImport.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#ModelImport.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#ModelImport.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#ModelImport.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#ModelImport.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#ModelImport.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`AnalysisTypeDimensionSetting`](#ModelImport.AnalysisTypeDimensionSetting)Gets or sets the AnalysisTypeDimensionSetting.[`ApplicationSourceSetting`](#ModelImport.ApplicationSourceSetting)Gets the ApplicationSourceSetting.[`BodyGroupByAnsysElmTypeNumber`](#ModelImport.BodyGroupByAnsysElmTypeNumber)Gets or sets the BodyGroupByAnsysElmTypeNumber.[`BodyGroupByMaterialNumber`](#ModelImport.BodyGroupByMaterialNumber)Gets or sets the BodyGroupByMaterialNumber.[`BodyGroupByThickness`](#ModelImport.BodyGroupByThickness)Gets or sets the BodyGroupByThickness.[`Children`](#ModelImport.Children)Gets the list of children.[`Comments`](#ModelImport.Comments)Gets the list of associated comments.[`CreateGeometry`](#ModelImport.CreateGeometry)Gets or sets the CreateGeometry.[`CreateGeometryEdgeComponents`](#ModelImport.CreateGeometryEdgeComponents)Gets or sets the CreateGeometryEdgeComponents.[`CreateGeometryFaceComponents`](#ModelImport.CreateGeometryFaceComponents)Gets or sets the CreateGeometryFaceComponents.[`CreateGeometryVertexComponent`](#ModelImport.CreateGeometryVertexComponent)Gets or sets the CreateGeometryVertexComponent.[`DataModelObjectCategory`](#ModelImport.DataModelObjectCategory)Gets the current DataModelObject’s category.[`ElementComponentKey`](#ModelImport.ElementComponentKey)Gets or sets the ElementComponentKey.[`ElementOffset`](#ModelImport.ElementOffset)Gets or sets the ElementOffset.[`FaceComponentKey`](#ModelImport.FaceComponentKey)Gets or sets the FaceComponentKey.[`Figures`](#ModelImport.Figures)Gets the list of associated figures.[`GeometryComponentKey`](#ModelImport.GeometryComponentKey)Gets or sets the GeometryComponentKey.[`Images`](#ModelImport.Images)Gets the list of associated images.[`ImportMaterials`](#ModelImport.ImportMaterials)Gets or sets the ImportMaterials.[`InternalObject`](#ModelImport.InternalObject)Gets the internal object. For advanced usage only.[`MaterialConsolidation`](#ModelImport.MaterialConsolidation)Gets or sets the MaterialConsolidation.[`ModelImportSourceFilePath`](#ModelImport.ModelImportSourceFilePath)Gets or sets the ModelImportSourceFilePath.[`NodalComponentKey`](#ModelImport.NodalComponentKey)Gets or sets the NodalComponentKey.[`NodeAndElementRenumberingMethod`](#ModelImport.NodeAndElementRenumberingMethod)Gets or sets the NodeAndElementRenumberingMethod.[`NodeOffset`](#ModelImport.NodeOffset)Gets or sets the NodeOffset.[`ProcessElementComponents`](#ModelImport.ProcessElementComponents)Gets or sets the ProcessElementComponents.[`ProcessFaceComponents`](#ModelImport.ProcessFaceComponents)Gets or sets the ProcessFaceComponents.[`ProcessLineBodies`](#ModelImport.ProcessLineBodies)Gets or sets the ProcessLineBodies.[`ProcessMesh200Elms`](#ModelImport.ProcessMesh200Elms)Gets or sets the ProcessMesh200Elms.[`ProcessModelData`](#ModelImport.ProcessModelData)Gets or sets the ProcessModelData.[`ProcessNodalComponents`](#ModelImport.ProcessNodalComponents)Gets or sets the ProcessNodalComponents.[`ProcessValidBlockedCDBFile`](#ModelImport.ProcessValidBlockedCDBFile)Gets or sets the ProcessValidBlockedCDBFile.[`Properties`](#ModelImport.Properties)Gets the list of properties for this object.[`SourceIdentifier`](#ModelImport.SourceIdentifier)Gets the SourceIdentifier.[`ToleranceAngle`](#ModelImport.ToleranceAngle)Gets or sets the ToleranceAngle.[`UnitSystemTypeForImport`](#ModelImport.UnitSystemTypeForImport)Gets or sets the UnitSystemTypeForImport.[`VertexInsertionAngle`](#ModelImport.VertexInsertionAngle)Gets or sets the VertexInsertionAngle.[`VisibleProperties`](#ModelImport.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="ModelImport.AnalysisTypeDimensionSetting"></a>

### *property* ModelImport.AnalysisTypeDimensionSetting *: [Ansys.Mechanical.DataModel.Enums.AnalysisTypeDimensionEnum](../../../Mechanical/DataModel/Enums/AnalysisTypeDimensionEnum.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.AnalysisTypeDimensionEnum) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AnalysisTypeDimensionSetting.

<a id="ModelImport.ApplicationSourceSetting"></a>

### *property* ModelImport.ApplicationSourceSetting *: [Ansys.Mechanical.DataModel.Enums.ApplicationSourceEnum](../../../Mechanical/DataModel/Enums/ApplicationSourceEnum.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.ApplicationSourceEnum) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ApplicationSourceSetting.

<a id="ModelImport.BodyGroupByAnsysElmTypeNumber"></a>

### *property* ModelImport.BodyGroupByAnsysElmTypeNumber *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BodyGroupByAnsysElmTypeNumber.

<a id="ModelImport.BodyGroupByMaterialNumber"></a>

### *property* ModelImport.BodyGroupByMaterialNumber *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BodyGroupByMaterialNumber.

<a id="ModelImport.BodyGroupByThickness"></a>

### *property* ModelImport.BodyGroupByThickness *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BodyGroupByThickness.

<a id="ModelImport.Children"></a>

### *property* ModelImport.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="ModelImport.Comments"></a>

### *property* ModelImport.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="ModelImport.CreateGeometry"></a>

### *property* ModelImport.CreateGeometry *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CreateGeometry.

<a id="ModelImport.CreateGeometryEdgeComponents"></a>

### *property* ModelImport.CreateGeometryEdgeComponents *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CreateGeometryEdgeComponents.

<a id="ModelImport.CreateGeometryFaceComponents"></a>

### *property* ModelImport.CreateGeometryFaceComponents *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CreateGeometryFaceComponents.

<a id="ModelImport.CreateGeometryVertexComponent"></a>

### *property* ModelImport.CreateGeometryVertexComponent *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CreateGeometryVertexComponent.

<a id="ModelImport.DataModelObjectCategory"></a>

### *property* ModelImport.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="ModelImport.ElementComponentKey"></a>

### *property* ModelImport.ElementComponentKey *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ElementComponentKey.

<a id="ModelImport.ElementOffset"></a>

### *property* ModelImport.ElementOffset *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ElementOffset.

<a id="ModelImport.FaceComponentKey"></a>

### *property* ModelImport.FaceComponentKey *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the FaceComponentKey.

<a id="ModelImport.Figures"></a>

### *property* ModelImport.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="ModelImport.GeometryComponentKey"></a>

### *property* ModelImport.GeometryComponentKey *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GeometryComponentKey.

<a id="ModelImport.Images"></a>

### *property* ModelImport.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="ModelImport.ImportMaterials"></a>

### *property* ModelImport.ImportMaterials *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ImportMaterials.

<a id="ModelImport.InternalObject"></a>

### *property* ModelImport.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSModelImportAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="ModelImport.MaterialConsolidation"></a>

### *property* ModelImport.MaterialConsolidation *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MaterialConsolidation.

<a id="ModelImport.ModelImportSourceFilePath"></a>

### *property* ModelImport.ModelImportSourceFilePath *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ModelImportSourceFilePath.

<a id="ModelImport.NodalComponentKey"></a>

### *property* ModelImport.NodalComponentKey *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NodalComponentKey.

<a id="ModelImport.NodeAndElementRenumberingMethod"></a>

### *property* ModelImport.NodeAndElementRenumberingMethod *: [Ansys.Mechanical.DataModel.Enums.NodeAndElementRenumberingMethodType](../../../Mechanical/DataModel/Enums/NodeAndElementRenumberingMethodType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.NodeAndElementRenumberingMethodType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NodeAndElementRenumberingMethod.

<a id="ModelImport.NodeOffset"></a>

### *property* ModelImport.NodeOffset *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NodeOffset.

<a id="ModelImport.ProcessElementComponents"></a>

### *property* ModelImport.ProcessElementComponents *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessElementComponents.

<a id="ModelImport.ProcessFaceComponents"></a>

### *property* ModelImport.ProcessFaceComponents *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessFaceComponents.

<a id="ModelImport.ProcessLineBodies"></a>

### *property* ModelImport.ProcessLineBodies *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessLineBodies.

<a id="ModelImport.ProcessMesh200Elms"></a>

### *property* ModelImport.ProcessMesh200Elms *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessMesh200Elms.

<a id="ModelImport.ProcessModelData"></a>

### *property* ModelImport.ProcessModelData *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessModelData.

<a id="ModelImport.ProcessNodalComponents"></a>

### *property* ModelImport.ProcessNodalComponents *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessNodalComponents.

<a id="ModelImport.ProcessValidBlockedCDBFile"></a>

### *property* ModelImport.ProcessValidBlockedCDBFile *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ProcessValidBlockedCDBFile.

<a id="ModelImport.Properties"></a>

### *property* ModelImport.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="ModelImport.SourceIdentifier"></a>

### *property* ModelImport.SourceIdentifier *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the SourceIdentifier.

<a id="ModelImport.ToleranceAngle"></a>

### *property* ModelImport.ToleranceAngle *: [Ansys.Core.Units.Quantity](../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ToleranceAngle.

<a id="ModelImport.UnitSystemTypeForImport"></a>

### *property* ModelImport.UnitSystemTypeForImport *: [Ansys.Mechanical.DataModel.Enums.ModelImportUnitSystemType](../../../Mechanical/DataModel/Enums/ModelImportUnitSystemType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.ModelImportUnitSystemType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the UnitSystemTypeForImport.

<a id="ModelImport.VertexInsertionAngle"></a>

### *property* ModelImport.VertexInsertionAngle *: [Ansys.Core.Units.Quantity](../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the VertexInsertionAngle.

<a id="ModelImport.VisibleProperties"></a>

### *property* ModelImport.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="method-detail"></a>

## Method detail

<a id="ModelImport.Activate"></a>

### ModelImport.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="ModelImport.AddComment"></a>

### ModelImport.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="ModelImport.AddFigure"></a>

### ModelImport.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

<a id="ModelImport.AddImage"></a>

### ModelImport.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="ModelImport.CopyTo"></a>

### ModelImport.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="ModelImport.CreateParameter"></a>

### ModelImport.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="ModelImport.Duplicate"></a>

### ModelImport.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="ModelImport.GetChildren"></a>

### ModelImport.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="ModelImport.GetParameter"></a>

### ModelImport.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="ModelImport.GroupAllSimilarChildren"></a>

### ModelImport.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="ModelImport.GroupSimilarObjects"></a>

### ModelImport.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="ModelImport.PropertyByAPIName"></a>

### ModelImport.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="ModelImport.PropertyByName"></a>

### ModelImport.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="ModelImport.RemoveParameter"></a>

### ModelImport.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

Removes the parameter from the parameter set corresponding to the given property.