Gasket

class ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.MeshControls.Gasket

Bases: object

Defines a Gasket.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
CopyTo	Copies all visible properties from this object to another.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
GenerateMesh	Generate the Mesh.
GetChildren	Gets the list of children, filtered by type.
GetParameter	Gets the parameter corresponding to the given property.
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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
ElementOrder	Gets and Sets Element Order Property. The default value is Use Global Setting.
Figures	Gets the list of associated figures.
FreeFaceMeshType	Gets and Sets Free Face Mesh Type Property. The default value is Quad/Tri.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets and Sets the Location.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
Source	Gets and Sets the Source.
SourceScopingMethod	Gets and Sets Source Scoping Method Property. Geometry Selection enables you to select sources or targets manually using the Source option. Named Selection enables you to choose one Named Selection as a source or target using the Source Named Selection option.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property Gasket.ElementOrder: Ansys.Mechanical.DataModel.Enums.ElementOrder | None

Gets and Sets Element Order Property. The default value is Use Global Setting.

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

Gets the list of associated figures.

property Gasket.FreeFaceMeshType: Ansys.Mechanical.DataModel.MechanicalEnums.MultizoneMappedMeshType | None

Gets and Sets Free Face Mesh Type Property. The default value is Quad/Tri.

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

Gets the list of associated images.

property Gasket.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMeshControlAuto | None

Gets the internal object. For advanced usage only.

property Gasket.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets and Sets the Location.

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

Gets the list of properties for this object.

property Gasket.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Gasket.Source: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets and Sets the Source.

property Gasket.SourceScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets and Sets Source Scoping Method Property. Geometry Selection enables you to select sources or targets manually using the Source option. Named Selection enables you to choose one Named Selection as a source or target using the Source Named Selection option.

property Gasket.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

Gasket.Activate() → None

Activate the current object.

Gasket.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Gasket.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

Gasket.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.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

Gasket.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Gasket.GenerateMesh() → None

Generate the Mesh.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

Gasket.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Gasket.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.

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

Get a property by its unique name.

Gasket.RemoveParameter(propName: str) → None

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

Gasket.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.