PostContactTool

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.PostContactTool

Bases: object

Defines a PostContactTool.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddFluidPressure	Creates a new ContactFluidPressure
AddFrictionalStress	Creates a new ContactFrictionalStress
AddGap	Creates a new ContactGap
AddHeatFlux	Creates a new ContactHeatFlux
AddImage	Creates a new child Image.
AddInitialInformation	Creates a new ContactDataTable
AddPenetration	Creates a new ContactPenetration
AddPressure	Creates a new ContactPressure
AddSlidingDistance	Creates a new ContactSlidingDistance
AddStatus	Creates a new ContactStatus
ClearGeneratedData	Run the ClearGeneratedData action.
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.
EvaluateAllResults	Run the EvaluateAllResults action.
GenerateInitialContactResults	Run the GenerateInitialContactResults action.
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.

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property PostContactTool.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSContactToolAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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

Gets the list of properties for this object.

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

Gets or sets the ScopingMethod.

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

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

Method detail

PostContactTool.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

PostContactTool.AddFluidPressure() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactFluidPressure

Creates a new ContactFluidPressure

PostContactTool.AddFrictionalStress() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactFrictionalStress

Creates a new ContactFrictionalStress

PostContactTool.AddGap() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactGap

Creates a new ContactGap

PostContactTool.AddHeatFlux() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactHeatFlux

Creates a new ContactHeatFlux

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

PostContactTool.AddInitialInformation() → Ansys.ACT.Automation.Mechanical.Results.ContactDataTable

Creates a new ContactDataTable

PostContactTool.AddPenetration() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactPenetration

Creates a new ContactPenetration

PostContactTool.AddPressure() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactPressure

Creates a new ContactPressure

PostContactTool.AddSlidingDistance() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactSlidingDistance

Creates a new ContactSlidingDistance

PostContactTool.AddStatus() → Ansys.ACT.Automation.Mechanical.Results.ContactToolResults.ContactStatus

Creates a new ContactStatus

PostContactTool.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

PostContactTool.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

PostContactTool.EvaluateAllResults() → None

Run the EvaluateAllResults action.

PostContactTool.GenerateInitialContactResults() → None

Run the GenerateInitialContactResults action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

PostContactTool.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

PostContactTool.RemoveParameter(propName: str) → None

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