## On this page

  

 

 # `VirtualTopology`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.VirtualTopology"></a>

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

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

Defines a VirtualTopology.

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

## Overview

### Methods

NameDescription[`Activate`](#VirtualTopology.Activate)Activate the current object.[`AddComment`](#VirtualTopology.AddComment)Creates a new child Comment.[`AddFigure`](#VirtualTopology.AddFigure)Creates a new child Figure.[`AddImage`](#VirtualTopology.AddImage)Creates a new child Image.[`AddVirtualCell`](#VirtualTopology.AddVirtualCell)Add Virtual Cell.[`AddVirtualHardVertex`](#VirtualTopology.AddVirtualHardVertex)Add Virtual Hard Vertex.[`AddVirtualSplitEdgeAt`](#VirtualTopology.AddVirtualSplitEdgeAt)Add Virtual Split Edge at[`CopyTo`](#VirtualTopology.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#VirtualTopology.CreateParameter)Creates a new parameter for a Property.[`Delete`](#VirtualTopology.Delete)Run the Delete action.[`DeleteAllVirtualCells`](#VirtualTopology.DeleteAllVirtualCells)Delete all Virtual Cells.[`DeleteAllVirtualEntities`](#VirtualTopology.DeleteAllVirtualEntities)Delete all Virtual Entities.[`DeleteAllVirtualHardVertices`](#VirtualTopology.DeleteAllVirtualHardVertices)Delete all Virtual Split Hard Vertices.[`DeleteAllVirtualSplitEdges`](#VirtualTopology.DeleteAllVirtualSplitEdges)Delete all Virtual Split Edges.[`DeleteAllVirtualSplitFaces`](#VirtualTopology.DeleteAllVirtualSplitFaces)Delete all Virtual Split Faces.[`Duplicate`](#VirtualTopology.Duplicate)Creates a copy of the current DataModelObject.[`GenerateVirtualCells`](#VirtualTopology.GenerateVirtualCells)Generate the Virtual Cells on the selected/all entities.[`GetChildren`](#VirtualTopology.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#VirtualTopology.GetParameter)Gets the parameter corresponding to the given property.[`GetVirtualCellFromSelection`](#VirtualTopology.GetVirtualCellFromSelection)Gets the Virtual Cell from the selection.[`GroupAllSimilarChildren`](#VirtualTopology.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#VirtualTopology.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#VirtualTopology.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#VirtualTopology.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#VirtualTopology.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`VirtualSplitEdge`](#VirtualTopology.VirtualSplitEdge)Generate the Virtual Cells on the selected/all entities.[`VirtualSplitFaceAtVertices`](#VirtualTopology.VirtualSplitFaceAtVertices)Generate the Virtual Cells on the selected/all entities.### Properties

NameDescription[`AspectRatio`](#VirtualTopology.AspectRatio)Gets or sets the AspectRatio.[`AutomaticBehavior`](#VirtualTopology.AutomaticBehavior)Gets or sets the Behavior when Method is set to “Automatic”.[`Children`](#VirtualTopology.Children)Gets the list of children.[`Comments`](#VirtualTopology.Comments)Gets the list of associated comments.[`ContactAngle`](#VirtualTopology.ContactAngle)Gets or sets the ContactAngle.[`CustomFeatureAngle`](#VirtualTopology.CustomFeatureAngle)Gets or sets the CustomFeatureAngle.[`DataModelObjectCategory`](#VirtualTopology.DataModelObjectCategory)Gets the current DataModelObject’s category.[`EdgeAngle`](#VirtualTopology.EdgeAngle)Gets or sets the EdgeAngle.[`Figures`](#VirtualTopology.Figures)Gets the list of associated figures.[`GaussAngle`](#VirtualTopology.GaussAngle)Gets or sets the GaussAngle.[`GenerateOnUpdate`](#VirtualTopology.GenerateOnUpdate)Gets or sets the GenerateOnUpdate.[`Images`](#VirtualTopology.Images)Gets the list of associated images.[`InternalObject`](#VirtualTopology.InternalObject)Gets the internal object. For advanced usage only.[`LockPositionOfDependentEdgeSplits`](#VirtualTopology.LockPositionOfDependentEdgeSplits)Gets or sets the LockPositionOfDependentEdgeSplits.[`MaxEdgeLength`](#VirtualTopology.MaxEdgeLength)Gets or sets the MaxEdgeLength.[`MaxFaceArea`](#VirtualTopology.MaxFaceArea)Gets or sets the MaxFaceArea.[`MaxSliverWidth`](#VirtualTopology.MaxSliverWidth)Gets or sets the MaxSliverWidth.[`MergeFaceEdges`](#VirtualTopology.MergeFaceEdges)Gets or sets the MergeFaceEdges.[`Method`](#VirtualTopology.Method)Gets or sets the Method.[`MinEdgeLength`](#VirtualTopology.MinEdgeLength)Gets or sets the MinEdgeLength.[`MinFaceArea`](#VirtualTopology.MinFaceArea)Gets or sets the MinFaceArea.[`MinSliverWidth`](#VirtualTopology.MinSliverWidth)Gets or sets the MinSliverWidth.[`Properties`](#VirtualTopology.Properties)Gets the list of properties for this object.[`RepairBehavior`](#VirtualTopology.RepairBehavior)Gets or sets the Behavior when Method is set to “Repair”.[`SharedBoundaryRatio`](#VirtualTopology.SharedBoundaryRatio)Gets or sets the SharedBoundaryRatio.[`SimplifyFaces`](#VirtualTopology.SimplifyFaces)Gets or sets the SimplifyFaces.[`VirtualEdges`](#VirtualTopology.VirtualEdges)Gets the VirtualEdges.[`VirtualEntities`](#VirtualTopology.VirtualEntities)Gets the VirtualEntities.[`VirtualFaces`](#VirtualTopology.VirtualFaces)Gets the VirtualFaces.[`VirtualHardVertex`](#VirtualTopology.VirtualHardVertex)Gets the VirtualHardVertex.[`VirtualSplitEdges`](#VirtualTopology.VirtualSplitEdges)Gets the VirtualSplitEdges.[`VirtualSplitFaces`](#VirtualTopology.VirtualSplitFaces)Gets the VirtualSplitFaces.[`VisibleProperties`](#VirtualTopology.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="VirtualTopology.AspectRatio"></a>

### *property* VirtualTopology.AspectRatio *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AspectRatio.

<a id="VirtualTopology.AutomaticBehavior"></a>

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

Gets or sets the Behavior when Method is set to “Automatic”.

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

<a id="VirtualTopology.ContactAngle"></a>

### *property* VirtualTopology.ContactAngle *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ContactAngle.

<a id="VirtualTopology.CustomFeatureAngle"></a>

### *property* VirtualTopology.CustomFeatureAngle *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CustomFeatureAngle.

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

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

Gets the current DataModelObject’s category.

<a id="VirtualTopology.EdgeAngle"></a>

### *property* VirtualTopology.EdgeAngle *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the EdgeAngle.

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

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

Gets the list of associated figures.

<a id="VirtualTopology.GaussAngle"></a>

### *property* VirtualTopology.GaussAngle *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GaussAngle.

<a id="VirtualTopology.GenerateOnUpdate"></a>

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

Gets or sets the GenerateOnUpdate.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

<a id="VirtualTopology.LockPositionOfDependentEdgeSplits"></a>

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

Gets or sets the LockPositionOfDependentEdgeSplits.

<a id="VirtualTopology.MaxEdgeLength"></a>

### *property* VirtualTopology.MaxEdgeLength *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MaxEdgeLength.

<a id="VirtualTopology.MaxFaceArea"></a>

### *property* VirtualTopology.MaxFaceArea *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MaxFaceArea.

<a id="VirtualTopology.MaxSliverWidth"></a>

### *property* VirtualTopology.MaxSliverWidth *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MaxSliverWidth.

<a id="VirtualTopology.MergeFaceEdges"></a>

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

Gets or sets the MergeFaceEdges.

<a id="VirtualTopology.Method"></a>

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

Gets or sets the Method.

<a id="VirtualTopology.MinEdgeLength"></a>

### *property* VirtualTopology.MinEdgeLength *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MinEdgeLength.

<a id="VirtualTopology.MinFaceArea"></a>

### *property* VirtualTopology.MinFaceArea *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MinFaceArea.

<a id="VirtualTopology.MinSliverWidth"></a>

### *property* VirtualTopology.MinSliverWidth *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MinSliverWidth.

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

### *property* VirtualTopology.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="VirtualTopology.RepairBehavior"></a>

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

Gets or sets the Behavior when Method is set to “Repair”.

<a id="VirtualTopology.SharedBoundaryRatio"></a>

### *property* VirtualTopology.SharedBoundaryRatio *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SharedBoundaryRatio.

<a id="VirtualTopology.SimplifyFaces"></a>

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

Gets or sets the SimplifyFaces.

<a id="VirtualTopology.VirtualEdges"></a>

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

Gets the VirtualEdges.

<a id="VirtualTopology.VirtualEntities"></a>

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

Gets the VirtualEntities.

<a id="VirtualTopology.VirtualFaces"></a>

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

Gets the VirtualFaces.

<a id="VirtualTopology.VirtualHardVertex"></a>

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

Gets the VirtualHardVertex.

<a id="VirtualTopology.VirtualSplitEdges"></a>

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

Gets the VirtualSplitEdges.

<a id="VirtualTopology.VirtualSplitFaces"></a>

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

Gets the VirtualSplitFaces.

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

### *property* VirtualTopology.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="VirtualTopology.Activate"></a>

### VirtualTopology.Activate()

Activate the current object.

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

### VirtualTopology.AddComment()

Creates a new child Comment.

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

### VirtualTopology.AddFigure()

Creates a new child Figure.

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

### VirtualTopology.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="VirtualTopology.AddVirtualCell"></a>

### VirtualTopology.AddVirtualCell(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo)

Add Virtual Cell.

<a id="VirtualTopology.AddVirtualHardVertex"></a>

### VirtualTopology.AddVirtualHardVertex(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: [Ansys.Mechanical.Graphics.Point](../../../Mechanical/Graphics/Point.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.Graphics.Point))

Add Virtual Hard Vertex.

<a id="VirtualTopology.AddVirtualSplitEdgeAt"></a>

### VirtualTopology.AddVirtualSplitEdgeAt(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: [Ansys.Mechanical.Graphics.Point](../../../Mechanical/Graphics/Point.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.Graphics.Point))

Add Virtual Split Edge at

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

### VirtualTopology.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

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

### VirtualTopology.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="VirtualTopology.Delete"></a>

### VirtualTopology.Delete()

Run the Delete action.

<a id="VirtualTopology.DeleteAllVirtualCells"></a>

### VirtualTopology.DeleteAllVirtualCells()

Delete all Virtual Cells.

<a id="VirtualTopology.DeleteAllVirtualEntities"></a>

### VirtualTopology.DeleteAllVirtualEntities()

Delete all Virtual Entities.

<a id="VirtualTopology.DeleteAllVirtualHardVertices"></a>

### VirtualTopology.DeleteAllVirtualHardVertices()

Delete all Virtual Split Hard Vertices.

<a id="VirtualTopology.DeleteAllVirtualSplitEdges"></a>

### VirtualTopology.DeleteAllVirtualSplitEdges()

Delete all Virtual Split Edges.

<a id="VirtualTopology.DeleteAllVirtualSplitFaces"></a>

### VirtualTopology.DeleteAllVirtualSplitFaces()

Delete all Virtual Split Faces.

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

### VirtualTopology.Duplicate()

Creates a copy of the current DataModelObject.

<a id="VirtualTopology.GenerateVirtualCells"></a>

### VirtualTopology.GenerateVirtualCells(selectionInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo)

Generate the Virtual Cells on the selected/all entities.

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

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

Gets the list of children, filtered by type.

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

### VirtualTopology.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="VirtualTopology.GetVirtualCellFromSelection"></a>

### VirtualTopology.GetVirtualCellFromSelection(currentSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo)

Gets the Virtual Cell from the selection.

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

### VirtualTopology.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### VirtualTopology.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### VirtualTopology.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="VirtualTopology.PropertyByName"></a>

### VirtualTopology.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### VirtualTopology.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

<a id="VirtualTopology.VirtualSplitEdge"></a>

### VirtualTopology.VirtualSplitEdge(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, splitRatio: [float](https://docs.python.org/3/library/functions.html#float))

Generate the Virtual Cells on the selected/all entities.

<a id="VirtualTopology.VirtualSplitFaceAtVertices"></a>

### VirtualTopology.VirtualSplitFaceAtVertices(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo)

Generate the Virtual Cells on the selected/all entities.