VirtualTopology

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.VirtualTopology(internalObject: Any)

Bases: object

Defines a VirtualTopology.

Overview

Constructors

AddVirtualFaceImpl

AddVirtualFaceImpl method.

Methods

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.
CreateObjRef	CreateObjRef method.
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.
Equals	Equals method.
GenerateVirtualCells	Generate the Virtual Cells on the selected/all entities.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVirtualCellFromSelection	Gets the Virtual Cell from the selection.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.
VirtualSplitEdge	Generate the Virtual Cells on the selected/all entities.
VirtualSplitFaceAtVertices	Generate the Virtual Cells on the selected/all entities.

Properties

AspectRatio	Gets or sets the AspectRatio.
AttachedRefs	AttachedRefs property.
AutomaticBehavior	Gets or sets the Behavior when Method is set to “Automatic”.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property VirtualTopology.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property VirtualTopology.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property VirtualTopology.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property VirtualTopology.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

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: str) → 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.AddVirtualCell(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) → Iterable[Ansys.ACT.Automation.Mechanical.VirtualCell]

Add Virtual Cell.

classmethod VirtualTopology.AddVirtualFaceImpl(iOption: int, selectionManager: Ansys.Common.Interop.DSSelection.IWBSelection, source: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → Ansys.Common.Interop.AnsCoreObjects.IAnsUINTColl

AddVirtualFaceImpl method.

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

Add Virtual Hard Vertex.

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

Add Virtual Split Edge at

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

Copies all visible properties from this object to another.

VirtualTopology.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

VirtualTopology.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

VirtualTopology.Delete() → None

Run the Delete action.

VirtualTopology.DeleteAllVirtualCells() → None

Delete all Virtual Cells.

VirtualTopology.DeleteAllVirtualEntities() → None

Delete all Virtual Entities.

VirtualTopology.DeleteAllVirtualHardVertices() → None

Delete all Virtual Split Hard Vertices.

VirtualTopology.DeleteAllVirtualSplitEdges() → None

Delete all Virtual Split Edges.

VirtualTopology.DeleteAllVirtualSplitFaces() → None

Delete all Virtual Split Faces.

VirtualTopology.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

VirtualTopology.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

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

Generate the Virtual Cells on the selected/all entities.

VirtualTopology.GetAPIName(dispId: int) → str

Property name bound to dispId.

VirtualTopology.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

VirtualTopology.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

VirtualTopology.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

VirtualTopology.GetHashCode() → int

GetHashCode method.

VirtualTopology.GetIconFile() → System.Byte

GetIconFile method.

VirtualTopology.GetLifetimeService() → Any

GetLifetimeService method.

VirtualTopology.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

VirtualTopology.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

VirtualTopology.GetPath() → str

GetPath method.

VirtualTopology.GetPropertyName(dispId: int) → str

GetPropertyName method.

VirtualTopology.GetPropertyValue(name: str) → Any

GetPropertyValue method.

VirtualTopology.GetType() → type

GetType method.

VirtualTopology.GetVirtualCellFromSelection(currentSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo) → Ansys.ACT.Automation.Mechanical.VirtualCell

Gets the Virtual Cell from the selection.

VirtualTopology.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

VirtualTopology.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

VirtualTopology.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

VirtualTopology.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

VirtualTopology.InitializeLifetimeService() → Any

InitializeLifetimeService method.

VirtualTopology.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

VirtualTopology.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

VirtualTopology.PropertyByAPIName(name: str) → 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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

VirtualTopology.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

VirtualTopology.RemoveParameter(propName: str) → None

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

VirtualTopology.ToString() → str

ToString method.

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

Generate the Virtual Cells on the selected/all entities.

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

Generate the Virtual Cells on the selected/all entities.