BodyInteraction
Last update: 14.01.2025
BodyInteraction
class Ansys.ACT.Automation.Mechanical.Connections.BodyInteraction
Bases: object
Defines a BodyInteraction.
Overview
Methods
Name | Description |
---|---|
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. |
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
Name | Description |
---|---|
Breakable |
Gets or sets the Breakable. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
ContactType |
Gets or sets the ContactType. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
DecayConstant |
Gets or sets the DecayConstant. |
DynamicCoefficient |
Gets or sets the DynamicCoefficient. |
Figures |
Gets the list of associated figures. |
FrictionCoefficient |
Gets or sets the FrictionCoefficient. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
MaximumOffset |
Gets or sets the MaximumOffset. |
NormalForceExponent |
Gets or sets the NormalForceExponent. |
NormalForceLimit |
Gets or sets the NormalForceLimit. |
NormalStressExponent |
Gets or sets the NormalStressExponent. |
NormalStressLimit |
Gets or sets the NormalStressLimit. |
Properties |
Gets the list of properties for this object. |
ShearForceExponent |
Gets or sets the ShearForceExponent. |
ShearForceLimit |
Gets or sets the ShearForceLimit. |
ShearStressExponent |
Gets or sets the ShearStressExponent. |
ShearStressLimit |
Gets or sets the ShearStressLimit. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property BodyInteraction.Breakable : Ansys.Mechanical.DataModel.Enums.BondedBreakableType | None
Gets or sets the Breakable.
property BodyInteraction.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property BodyInteraction.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property BodyInteraction.ContactType : Ansys.Mechanical.DataModel.Enums.ContactType | None
Gets or sets the ContactType.
property BodyInteraction.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property BodyInteraction.DecayConstant : float | None
Gets or sets the DecayConstant.
property BodyInteraction.DynamicCoefficient : float | None
Gets or sets the DynamicCoefficient.
property BodyInteraction.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property BodyInteraction.FrictionCoefficient : float | None
Gets or sets the FrictionCoefficient.
property BodyInteraction.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property BodyInteraction.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSBodyInteractionAuto | None
Gets the internal object. For advanced usage only.
property BodyInteraction.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property BodyInteraction.MaximumOffset : Ansys.Core.Units.Quantity | None
Gets or sets the MaximumOffset.
property BodyInteraction.NormalForceExponent : float | None
Gets or sets the NormalForceExponent.
property BodyInteraction.NormalForceLimit : Ansys.Core.Units.Quantity | None
Gets or sets the NormalForceLimit.
property BodyInteraction.NormalStressExponent : float | None
Gets or sets the NormalStressExponent.
property BodyInteraction.NormalStressLimit : Ansys.Core.Units.Quantity | None
Gets or sets the NormalStressLimit.
property BodyInteraction.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property BodyInteraction.ShearForceExponent : float | None
Gets or sets the ShearForceExponent.
property BodyInteraction.ShearForceLimit : Ansys.Core.Units.Quantity | None
Gets or sets the ShearForceLimit.
property BodyInteraction.ShearStressExponent : float | None
Gets or sets the ShearStressExponent.
property BodyInteraction.ShearStressLimit : Ansys.Core.Units.Quantity | None
Gets or sets the ShearStressLimit.
property BodyInteraction.Suppressed : bool | None
Gets or sets the Suppressed.
property BodyInteraction.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
BodyInteraction.Activate()
Activate the current object.
BodyInteraction.AddComment()
Creates a new child Comment.
BodyInteraction.AddFigure()
Creates a new child Figure.
BodyInteraction.AddImage(filePath: str)
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.
BodyInteraction.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
BodyInteraction.CreateParameter(propName: str)
Creates a new parameter for a Property.
BodyInteraction.Delete()
Run the Delete action.
BodyInteraction.Duplicate()
Creates a copy of the current DataModelObject.
BodyInteraction.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
BodyInteraction.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
BodyInteraction.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
BodyInteraction.GroupSimilarObjects()
Run the GroupSimilarObjects action.
BodyInteraction.PropertyByAPIName(name: str)
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.
BodyInteraction.PropertyByName(name: str)
Get a property by its unique name.
BodyInteraction.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.