Skip to main content

Mechanical scripting interface

VirtualTopology

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.VirtualTopology

Bases: object

Defines a VirtualTopology.

Overview

Methods

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

Properties

Name Description
AspectRatio Gets or sets the AspectRatio.
AutomaticBehavior Gets or sets the Behavior when Method is set to “Automatic”.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactAngle Gets or sets the ContactAngle.
CustomFeatureAngle Gets or sets the CustomFeatureAngle.
DataModelObjectCategory Gets the current DataModelObject’s category.
EdgeAngle Gets or sets the EdgeAngle.
Figures Gets the list of associated figures.
GaussAngle Gets or sets the GaussAngle.
GenerateOnUpdate Gets or sets the GenerateOnUpdate.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LockPositionOfDependentEdgeSplits Gets or sets the LockPositionOfDependentEdgeSplits.
MaxEdgeLength Gets or sets the MaxEdgeLength.
MaxFaceArea Gets or sets the MaxFaceArea.
MaxSliverWidth Gets or sets the MaxSliverWidth.
MergeFaceEdges Gets or sets the MergeFaceEdges.
Method Gets or sets the Method.
MinEdgeLength Gets or sets the MinEdgeLength.
MinFaceArea Gets or sets the MinFaceArea.
MinSliverWidth Gets or sets the MinSliverWidth.
Properties Gets the list of properties for this object.
RepairBehavior Gets or sets the Behavior when Method is set to “Repair”.
SharedBoundaryRatio Gets or sets the SharedBoundaryRatio.
SimplifyFaces Gets or sets the SimplifyFaces.
VirtualEdges Gets the VirtualEdges.
VirtualEntities Gets the VirtualEntities.
VirtualFaces Gets the VirtualFaces.
VirtualHardVertex Gets the VirtualHardVertex.
VirtualSplitEdges Gets the VirtualSplitEdges.
VirtualSplitFaces Gets the VirtualSplitFaces.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property VirtualTopology.AspectRatio : float | None

Gets or sets the AspectRatio.

property VirtualTopology.AutomaticBehavior : Ansys.Mechanical.DataModel.Enums.VirtualCellGroupAutomaticBehaviorType | None

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

property VirtualTopology.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property VirtualTopology.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property VirtualTopology.ContactAngle : Ansys.Core.Units.Quantity | None

Gets or sets the ContactAngle.

property VirtualTopology.CustomFeatureAngle : Ansys.Core.Units.Quantity | None

Gets or sets the CustomFeatureAngle.

property VirtualTopology.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property VirtualTopology.EdgeAngle : Ansys.Core.Units.Quantity | None

Gets or sets the EdgeAngle.

property VirtualTopology.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property VirtualTopology.GaussAngle : Ansys.Core.Units.Quantity | None

Gets or sets the GaussAngle.

property VirtualTopology.GenerateOnUpdate : Ansys.Mechanical.DataModel.Enums.YesNoType | None

Gets or sets the GenerateOnUpdate.

property VirtualTopology.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property VirtualTopology.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSVirtualCellGroupAuto | None

Gets the internal object. For advanced usage only.

property VirtualTopology.LockPositionOfDependentEdgeSplits : Ansys.Mechanical.DataModel.Enums.YesNoType | None

Gets or sets the LockPositionOfDependentEdgeSplits.

property VirtualTopology.MaxEdgeLength : Ansys.Core.Units.Quantity | None

Gets or sets the MaxEdgeLength.

property VirtualTopology.MaxFaceArea : Ansys.Core.Units.Quantity | None

Gets or sets the MaxFaceArea.

property VirtualTopology.MaxSliverWidth : Ansys.Core.Units.Quantity | None

Gets or sets the MaxSliverWidth.

property VirtualTopology.MergeFaceEdges : Ansys.Mechanical.DataModel.Enums.YesNoType | None

Gets or sets the MergeFaceEdges.

property VirtualTopology.Method : Ansys.Mechanical.DataModel.Enums.VirtualCellGroupMethodType | None

Gets or sets the Method.

property VirtualTopology.MinEdgeLength : Ansys.Core.Units.Quantity | None

Gets or sets the MinEdgeLength.

property VirtualTopology.MinFaceArea : Ansys.Core.Units.Quantity | None

Gets or sets the MinFaceArea.

property VirtualTopology.MinSliverWidth : Ansys.Core.Units.Quantity | None

Gets or sets the MinSliverWidth.

property VirtualTopology.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property VirtualTopology.RepairBehavior : Ansys.Mechanical.DataModel.Enums.VirtualCellGroupRepairBehaviorType | None

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

property VirtualTopology.SharedBoundaryRatio : float | None

Gets or sets the SharedBoundaryRatio.

property VirtualTopology.SimplifyFaces : Ansys.Mechanical.DataModel.Enums.YesNoType | None

Gets or sets the SimplifyFaces.

property VirtualTopology.VirtualEdges : int | None

Gets the VirtualEdges.

property VirtualTopology.VirtualEntities : int | None

Gets the VirtualEntities.

property VirtualTopology.VirtualFaces : int | None

Gets the VirtualFaces.

property VirtualTopology.VirtualHardVertex : int | None

Gets the VirtualHardVertex.

property VirtualTopology.VirtualSplitEdges : int | None

Gets the VirtualSplitEdges.

property VirtualTopology.VirtualSplitFaces : int | None

Gets the VirtualSplitFaces.

property VirtualTopology.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

VirtualTopology.Activate()

Activate the current object.

VirtualTopology.AddComment()

Creates a new child Comment.

VirtualTopology.AddFigure()

Creates a new child Figure.

VirtualTopology.AddImage(filePath: str)

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.

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

Add Virtual Cell.

VirtualTopology.AddVirtualHardVertex(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: Ansys.Mechanical.Graphics.Point)

Add Virtual Hard Vertex.

VirtualTopology.AddVirtualSplitEdgeAt(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: Ansys.Mechanical.Graphics.Point)

Add Virtual Split Edge at

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

Copies all visible properties from this object to another.

VirtualTopology.CreateParameter(propName: str)

Creates a new parameter for a Property.

VirtualTopology.Delete()

Run the Delete action.

VirtualTopology.DeleteAllVirtualCells()

Delete all Virtual Cells.

VirtualTopology.DeleteAllVirtualEntities()

Delete all Virtual Entities.

VirtualTopology.DeleteAllVirtualHardVertices()

Delete all Virtual Split Hard Vertices.

VirtualTopology.DeleteAllVirtualSplitEdges()

Delete all Virtual Split Edges.

VirtualTopology.DeleteAllVirtualSplitFaces()

Delete all Virtual Split Faces.

VirtualTopology.Duplicate()

Creates a copy of the current DataModelObject.

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

Generate the Virtual Cells on the selected/all entities.

VirtualTopology.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

VirtualTopology.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

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

Gets the Virtual Cell from the selection.

VirtualTopology.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

VirtualTopology.GroupSimilarObjects()

Run the GroupSimilarObjects action.

VirtualTopology.PropertyByAPIName(name: str)

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.

VirtualTopology.PropertyByName(name: str)

Get a property by its unique name.

VirtualTopology.RemoveParameter(propName: str)

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

VirtualTopology.VirtualSplitEdge(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, splitRatio: float)

Generate the Virtual Cells on the selected/all entities.

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

Generate the Virtual Cells on the selected/all entities.