`VirtualTopology`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.VirtualTopology#

Bases: object

Defines a VirtualTopology.

Overview#

Methods

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

Properties

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

Property detail#

property VirtualTopology.AutomaticBehavior: Ansys.Mechanical.DataModel.Enums.VirtualCellGroupAutomaticBehaviorType | None: Gets or sets the Behavior when Method is set to “Automatic”.

property VirtualTopology.RepairBehavior: Ansys.Mechanical.DataModel.Enums.VirtualCellGroupRepairBehaviorType | None: Gets or sets the Behavior when Method is set to “Repair”.

property VirtualTopology.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSVirtualCellGroupAuto | None: Gets the internal object. For advanced usage only.

property VirtualTopology.AspectRatio: System.Double | None: Gets or sets the AspectRatio.

property VirtualTopology.SharedBoundaryRatio: System.Double | None: Gets or sets the SharedBoundaryRatio.

property VirtualTopology.VirtualEdges: System.Int32 | None: Gets the VirtualEdges.

property VirtualTopology.VirtualEntities: System.Int32 | None: Gets the VirtualEntities.

property VirtualTopology.VirtualFaces: System.Int32 | None: Gets the VirtualFaces.

property VirtualTopology.VirtualHardVertex: System.Int32 | None: Gets the VirtualHardVertex.

property VirtualTopology.VirtualSplitEdges: System.Int32 | None: Gets the VirtualSplitEdges.

property VirtualTopology.VirtualSplitFaces: System.Int32 | None: Gets the VirtualSplitFaces.

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.EdgeAngle: Ansys.Core.Units.Quantity | None: Gets or sets the EdgeAngle.

property VirtualTopology.GaussAngle: Ansys.Core.Units.Quantity | None: Gets or sets the GaussAngle.

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.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.LockPositionOfDependentEdgeSplits: Ansys.Mechanical.DataModel.Enums.YesNoType | None: Gets or sets the LockPositionOfDependentEdgeSplits.

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.GenerateOnUpdate: Ansys.Mechanical.DataModel.Enums.YesNoType | None: Gets or sets the GenerateOnUpdate.

property VirtualTopology.SimplifyFaces: Ansys.Mechanical.DataModel.Enums.YesNoType | None: Gets or sets the SimplifyFaces.

property VirtualTopology.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property VirtualTopology.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property VirtualTopology.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property VirtualTopology.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property VirtualTopology.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property VirtualTopology.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property VirtualTopology.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property VirtualTopology.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

VirtualTopology.GetVirtualCellFromSelection(currentSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo) → Ansys.ACT.Automation.Mechanical.VirtualCell: Gets the Virtual Cell from the selection.

VirtualTopology.GenerateVirtualCells(selectionInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) → System.Void: Generate the Virtual Cells on the selected/all entities.

VirtualTopology.VirtualSplitFaceAtVertices(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) → System.Void: Generate the Virtual Cells on the selected/all entities.

VirtualTopology.VirtualSplitEdge(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, splitRatio: System.Double) → System.Void: Generate the Virtual Cells on the selected/all entities.

VirtualTopology.DeleteAllVirtualCells() → System.Void: Delete all Virtual Cells.

VirtualTopology.DeleteAllVirtualEntities() → System.Void: Delete all Virtual Entities.

VirtualTopology.DeleteAllVirtualSplitEdges() → System.Void: Delete all Virtual Split Edges.

VirtualTopology.DeleteAllVirtualSplitFaces() → System.Void: Delete all Virtual Split Faces.

VirtualTopology.DeleteAllVirtualHardVertices() → System.Void: Delete all Virtual Split Hard Vertices.

VirtualTopology.AddVirtualCell(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.VirtualCell]: Add Virtual Cell.

VirtualTopology.AddVirtualHardVertex(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: Ansys.Mechanical.Graphics.Point) → System.Void: Add Virtual Hard Vertex.

VirtualTopology.Delete() → System.Void: Run the Delete action.

VirtualTopology.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

VirtualTopology.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

VirtualTopology.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

VirtualTopology.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

VirtualTopology.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.Activate() → System.Void: Activate the current object.

VirtualTopology.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

VirtualTopology.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

VirtualTopology.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

VirtualTopology.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

VirtualTopology.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

VirtualTopology.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

VirtualTopology.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

VirtualTopology.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.