.. vale off :class:`VirtualTopology` ======================== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.VirtualTopology Bases: :py:obj:`object` Defines a VirtualTopology. .. !! processed by numpydoc !! .. py:currentmodule:: VirtualTopology Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetVirtualCellFromSelection` - Gets the Virtual Cell from the selection. * - :py:attr:`~GenerateVirtualCells` - Generate the Virtual Cells on the selected/all entities. * - :py:attr:`~VirtualSplitFaceAtVertices` - Generate the Virtual Cells on the selected/all entities. * - :py:attr:`~VirtualSplitEdge` - Generate the Virtual Cells on the selected/all entities. * - :py:attr:`~DeleteAllVirtualCells` - Delete all Virtual Cells. * - :py:attr:`~DeleteAllVirtualEntities` - Delete all Virtual Entities. * - :py:attr:`~DeleteAllVirtualSplitEdges` - Delete all Virtual Split Edges. * - :py:attr:`~DeleteAllVirtualSplitFaces` - Delete all Virtual Split Faces. * - :py:attr:`~DeleteAllVirtualHardVertices` - Delete all Virtual Split Hard Vertices. * - :py:attr:`~AddVirtualCell` - Add Virtual Cell. * - :py:attr:`~AddVirtualHardVertex` - Add Virtual Hard Vertex. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~AutomaticBehavior` - Gets or sets the Behavior when Method is set to "Automatic". * - :py:attr:`~RepairBehavior` - Gets or sets the Behavior when Method is set to "Repair". * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~AspectRatio` - Gets or sets the AspectRatio. * - :py:attr:`~SharedBoundaryRatio` - Gets or sets the SharedBoundaryRatio. * - :py:attr:`~VirtualEdges` - Gets the VirtualEdges. * - :py:attr:`~VirtualEntities` - Gets the VirtualEntities. * - :py:attr:`~VirtualFaces` - Gets the VirtualFaces. * - :py:attr:`~VirtualHardVertex` - Gets the VirtualHardVertex. * - :py:attr:`~VirtualSplitEdges` - Gets the VirtualSplitEdges. * - :py:attr:`~VirtualSplitFaces` - Gets the VirtualSplitFaces. * - :py:attr:`~ContactAngle` - Gets or sets the ContactAngle. * - :py:attr:`~CustomFeatureAngle` - Gets or sets the CustomFeatureAngle. * - :py:attr:`~EdgeAngle` - Gets or sets the EdgeAngle. * - :py:attr:`~GaussAngle` - Gets or sets the GaussAngle. * - :py:attr:`~MaxEdgeLength` - Gets or sets the MaxEdgeLength. * - :py:attr:`~MaxFaceArea` - Gets or sets the MaxFaceArea. * - :py:attr:`~MaxSliverWidth` - Gets or sets the MaxSliverWidth. * - :py:attr:`~MinEdgeLength` - Gets or sets the MinEdgeLength. * - :py:attr:`~MinFaceArea` - Gets or sets the MinFaceArea. * - :py:attr:`~MinSliverWidth` - Gets or sets the MinSliverWidth. * - :py:attr:`~LockPositionOfDependentEdgeSplits` - Gets or sets the LockPositionOfDependentEdgeSplits. * - :py:attr:`~MergeFaceEdges` - Gets or sets the MergeFaceEdges. * - :py:attr:`~Method` - Gets or sets the Method. * - :py:attr:`~GenerateOnUpdate` - Gets or sets the GenerateOnUpdate. * - :py:attr:`~SimplifyFaces` - Gets or sets the SimplifyFaces. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: AutomaticBehavior :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.VirtualCellGroupAutomaticBehaviorType] Gets or sets the Behavior when Method is set to "Automatic". .. !! processed by numpydoc !! .. py:property:: RepairBehavior :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.VirtualCellGroupRepairBehaviorType] Gets or sets the Behavior when Method is set to "Repair". .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSVirtualCellGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: AspectRatio :no-index: :type: Optional[System.Double] Gets or sets the AspectRatio. .. !! processed by numpydoc !! .. py:property:: SharedBoundaryRatio :no-index: :type: Optional[System.Double] Gets or sets the SharedBoundaryRatio. .. !! processed by numpydoc !! .. py:property:: VirtualEdges :no-index: :type: Optional[System.Int32] Gets the VirtualEdges. .. !! processed by numpydoc !! .. py:property:: VirtualEntities :no-index: :type: Optional[System.Int32] Gets the VirtualEntities. .. !! processed by numpydoc !! .. py:property:: VirtualFaces :no-index: :type: Optional[System.Int32] Gets the VirtualFaces. .. !! processed by numpydoc !! .. py:property:: VirtualHardVertex :no-index: :type: Optional[System.Int32] Gets the VirtualHardVertex. .. !! processed by numpydoc !! .. py:property:: VirtualSplitEdges :no-index: :type: Optional[System.Int32] Gets the VirtualSplitEdges. .. !! processed by numpydoc !! .. py:property:: VirtualSplitFaces :no-index: :type: Optional[System.Int32] Gets the VirtualSplitFaces. .. !! processed by numpydoc !! .. py:property:: ContactAngle :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the ContactAngle. .. !! processed by numpydoc !! .. py:property:: CustomFeatureAngle :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CustomFeatureAngle. .. !! processed by numpydoc !! .. py:property:: EdgeAngle :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the EdgeAngle. .. !! processed by numpydoc !! .. py:property:: GaussAngle :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the GaussAngle. .. !! processed by numpydoc !! .. py:property:: MaxEdgeLength :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MaxEdgeLength. .. !! processed by numpydoc !! .. py:property:: MaxFaceArea :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MaxFaceArea. .. !! processed by numpydoc !! .. py:property:: MaxSliverWidth :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MaxSliverWidth. .. !! processed by numpydoc !! .. py:property:: MinEdgeLength :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MinEdgeLength. .. !! processed by numpydoc !! .. py:property:: MinFaceArea :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MinFaceArea. .. !! processed by numpydoc !! .. py:property:: MinSliverWidth :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MinSliverWidth. .. !! processed by numpydoc !! .. py:property:: LockPositionOfDependentEdgeSplits :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoType] Gets or sets the LockPositionOfDependentEdgeSplits. .. !! processed by numpydoc !! .. py:property:: MergeFaceEdges :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoType] Gets or sets the MergeFaceEdges. .. !! processed by numpydoc !! .. py:property:: Method :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.VirtualCellGroupMethodType] Gets or sets the Method. .. !! processed by numpydoc !! .. py:property:: GenerateOnUpdate :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoType] Gets or sets the GenerateOnUpdate. .. !! processed by numpydoc !! .. py:property:: SimplifyFaces :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoType] Gets or sets the SimplifyFaces. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: GetVirtualCellFromSelection(currentSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo) -> Ansys.ACT.Automation.Mechanical.VirtualCell :no-index: Gets the Virtual Cell from the selection. .. !! processed by numpydoc !! .. py:method:: GenerateVirtualCells(selectionInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) -> System.Void :no-index: Generate the Virtual Cells on the selected/all entities. .. !! processed by numpydoc !! .. py:method:: VirtualSplitFaceAtVertices(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) -> System.Void :no-index: Generate the Virtual Cells on the selected/all entities. .. !! processed by numpydoc !! .. py:method:: VirtualSplitEdge(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, splitRatio: System.Double) -> System.Void :no-index: Generate the Virtual Cells on the selected/all entities. .. !! processed by numpydoc !! .. py:method:: DeleteAllVirtualCells() -> System.Void :no-index: Delete all Virtual Cells. .. !! processed by numpydoc !! .. py:method:: DeleteAllVirtualEntities() -> System.Void :no-index: Delete all Virtual Entities. .. !! processed by numpydoc !! .. py:method:: DeleteAllVirtualSplitEdges() -> System.Void :no-index: Delete all Virtual Split Edges. .. !! processed by numpydoc !! .. py:method:: DeleteAllVirtualSplitFaces() -> System.Void :no-index: Delete all Virtual Split Faces. .. !! processed by numpydoc !! .. py:method:: DeleteAllVirtualHardVertices() -> System.Void :no-index: Delete all Virtual Split Hard Vertices. .. !! processed by numpydoc !! .. py:method:: AddVirtualCell(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo) -> System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.VirtualCell] :no-index: Add Virtual Cell. .. !! processed by numpydoc !! .. py:method:: AddVirtualHardVertex(iSelInfo: Ansys.ACT.Interfaces.Common.ISelectionInfo, point: Ansys.Mechanical.Graphics.Point) -> System.Void :no-index: Add Virtual Hard Vertex. .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: 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] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: 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. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on