Joint

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Connections.Joint

Bases: object

Defines a Joint.

Overview

Methods

PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint action.
AddCommandSnippet	Creates a new CommandSnippet
FlipReferenceMobile	Run the FlipReferenceMobile action.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
Delete	Run the Delete action.
GetChildren	Gets the list of children, filtered by type.
GetChildren	Gets the list of children, filtered by type.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
Duplicate	Creates a copy of the current DataModelObject.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PropertyByName	Get a property by its unique name.
PropertyByAPIName	Get a property by its API name.
CreateParameter	Creates a new parameter for a Property.
GetParameter	Gets the parameter corresponding to the given property.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.

Properties

BushingWorksheet	Returns the Bushing Coeffients worksheet associated with Bushing Joint.
InternalObject	Gets the internal object. For advanced usage only.
FrictionCoefficient	Gets or sets the FrictionCoefficient.
JointElementAPDLName	Gets or sets the JointElementAPDLName.
RestitutionFactor	Gets or sets the RestitutionFactor.
MobileBeamMaterial	Gets or sets the MobileBeamMaterial.
MobileBody	Gets the MobileBody.
ReferenceBeamMaterial	Gets or sets the ReferenceBeamMaterial.
ReferenceBody	Gets the ReferenceBody.
EffectiveLength	Gets or sets the EffectiveLength.
InnerRadius	Gets or sets the InnerRadius.
OuterRadius	Gets or sets the OuterRadius.
Radius	Gets or sets the Radius.
MobilePinballRegion	Gets or sets the MobilePinballRegion.
ReferencePinballRegion	Gets or sets the ReferencePinballRegion.
RadialGapHeight	Gets or sets the RadialGapHeight.
RadialGapInnerDiameter	Gets or sets the RadialGapInnerDiameter.
RadialOuterDiameter	Gets or sets the RadialOuterDiameter.
ScrewPitch	Gets or sets the ScrewPitch.
RXMaximum	Gets or sets the RXMaximum.
RXMinimum	Gets or sets the RXMinimum.
RYMaximum	Gets or sets the RYMaximum.
RYMinimum	Gets or sets the RYMinimum.
RZMaximum	Gets or sets the RZMaximum.
RZMinimum	Gets or sets the RZMinimum.
XMaximum	Gets or sets the XMaximum.
XMinimum	Gets or sets the XMinimum.
YMaximum	Gets or sets the YMaximum.
YMinimum	Gets or sets the YMinimum.
ZMaximum	Gets or sets the ZMaximum.
ZMinimum	Gets or sets the ZMinimum.
TorsionalDamping	Gets or sets the TorsionalDamping.
TorsionalStiffness	Gets or sets the TorsionalStiffness.
MobileBeamRadius	Gets or sets the MobileBeamRadius.
ReferenceBeamRadius	Gets or sets the ReferenceBeamRadius.
GeneralPrimitiveType	Gets or sets the GeneralPrimitiveType.
InitialPosition	Gets or sets the InitialPosition.
MobileBehavior	Gets or sets the MobileBehavior.
ReferenceBehavior	Gets or sets the ReferenceBehavior.
Formulation	Gets or sets the Formulation.
JointFrictionType	Gets or sets the JointFrictionType.
MobileFormulation	Gets or sets the MobileFormulation.
RadialGapType	Gets or sets the RadialGapType.
ReferenceFormulation	Gets or sets the ReferenceFormulation.
ConnectionType	Gets or sets the ConnectionType.
RXMaximumType	Gets or sets the RXMaximumType.
RXMinimumType	Gets or sets the RXMinimumType.
RYMaximumType	Gets or sets the RYMaximumType.
RYMinimumType	Gets or sets the RYMinimumType.
RZMaximumType	Gets or sets the RZMaximumType.
RZMinimumType	Gets or sets the RZMinimumType.
XMaximumType	Gets or sets the XMaximumType.
XMinimumType	Gets or sets the XMinimumType.
YMaximumType	Gets or sets the YMaximumType.
YMinimumType	Gets or sets the YMinimumType.
ZMaximumType	Gets or sets the ZMaximumType.
ZMinimumType	Gets or sets the ZMinimumType.
Type	Gets or sets the Type.
MobileAppliedBy	Gets or sets the MobileAppliedBy.
ReferenceAppliedBy	Gets or sets the ReferenceAppliedBy.
Rotations	Gets or sets the Rotations.
SolverElementType	Gets or sets the SolverElementType.
TranslationX	Gets or sets the TranslationX.
TranslationY	Gets or sets the TranslationY.
TranslationZ	Gets or sets the TranslationZ.
MobileRelaxationMethod	Gets or sets the MobileRelaxationMethod.
ReferenceRelaxationMethod	Gets or sets the ReferenceRelaxationMethod.
Suppressed	Gets or sets the Suppressed.
SuppressedForSolve	Gets the SuppressedForSolve.
ElementCoordinateSystem	Gets or sets the ElementCoordinateSystem.
MobileCoordinateSystem	Gets or sets the MobileCoordinateSystem.
ReferenceCoordinateSystem	Gets or sets the ReferenceCoordinateSystem.
MobileLocation	Gets or sets the MobileLocation.
CurveOrientationSurface	Gets or sets the CurveOrientationSurface.
ReferenceLocation	Gets or sets the ReferenceLocation.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
ReadOnly	Gets or sets the ReadOnly.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Joint.BushingWorksheet: Ansys.ACT.Interfaces.Common.IWorksheet | None

Returns the Bushing Coeffients worksheet associated with Bushing Joint.

property Joint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSJointAuto | None

Gets the internal object. For advanced usage only.

property Joint.FrictionCoefficient: System.Double | None

Gets or sets the FrictionCoefficient.

property Joint.JointElementAPDLName: System.String | None

Gets or sets the JointElementAPDLName.

property Joint.RestitutionFactor: System.Double | None

Gets or sets the RestitutionFactor.

property Joint.MobileBeamMaterial: System.String | None

Gets or sets the MobileBeamMaterial.

property Joint.MobileBody: System.String | None

Gets the MobileBody.

property Joint.ReferenceBeamMaterial: System.String | None

Gets or sets the ReferenceBeamMaterial.

property Joint.ReferenceBody: System.String | None

Gets the ReferenceBody.

property Joint.EffectiveLength: Ansys.Core.Units.Quantity | None

Gets or sets the EffectiveLength.

property Joint.InnerRadius: Ansys.Core.Units.Quantity | None

Gets or sets the InnerRadius.

property Joint.OuterRadius: Ansys.Core.Units.Quantity | None

Gets or sets the OuterRadius.

property Joint.Radius: Ansys.Core.Units.Quantity | None

Gets or sets the Radius.

property Joint.MobilePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the MobilePinballRegion.

property Joint.ReferencePinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the ReferencePinballRegion.

property Joint.RadialGapHeight: Ansys.Core.Units.Quantity | None

Gets or sets the RadialGapHeight.

property Joint.RadialGapInnerDiameter: Ansys.Core.Units.Quantity | None

Gets or sets the RadialGapInnerDiameter.

property Joint.RadialOuterDiameter: Ansys.Core.Units.Quantity | None

Gets or sets the RadialOuterDiameter.

property Joint.ScrewPitch: Ansys.Core.Units.Quantity | None

Gets or sets the ScrewPitch.

property Joint.RXMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RXMaximum.

property Joint.RXMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RXMinimum.

property Joint.RYMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RYMaximum.

property Joint.RYMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RYMinimum.

property Joint.RZMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RZMaximum.

property Joint.RZMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RZMinimum.

property Joint.XMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the XMaximum.

property Joint.XMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the XMinimum.

property Joint.YMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the YMaximum.

property Joint.YMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the YMinimum.

property Joint.ZMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the ZMaximum.

property Joint.ZMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the ZMinimum.

property Joint.TorsionalDamping: Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalDamping.

property Joint.TorsionalStiffness: Ansys.Core.Units.Quantity | None

Gets or sets the TorsionalStiffness.

property Joint.MobileBeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the MobileBeamRadius.

property Joint.ReferenceBeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceBeamRadius.

property Joint.GeneralPrimitiveType: Ansys.Mechanical.DataModel.Enums.JointGeneralPrimitiveType | None

Gets or sets the GeneralPrimitiveType.

property Joint.InitialPosition: Ansys.Mechanical.DataModel.Enums.JointInitialPosition | None

Gets or sets the InitialPosition.

property Joint.MobileBehavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the MobileBehavior.

property Joint.ReferenceBehavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the ReferenceBehavior.

property Joint.Formulation: Ansys.Mechanical.DataModel.Enums.JointFormulation | None

Gets or sets the Formulation.

property Joint.JointFrictionType: Ansys.Mechanical.DataModel.Enums.JointFrictionType | None

Gets or sets the JointFrictionType.

property Joint.MobileFormulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None

Gets or sets the MobileFormulation.

property Joint.RadialGapType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RadialGapType.

property Joint.ReferenceFormulation: Ansys.Mechanical.DataModel.Enums.RemotePointFormulation | None

Gets or sets the ReferenceFormulation.

property Joint.ConnectionType: Ansys.Mechanical.DataModel.Enums.JointScopingType | None

Gets or sets the ConnectionType.

property Joint.RXMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RXMaximumType.

property Joint.RXMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RXMinimumType.

property Joint.RYMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RYMaximumType.

property Joint.RYMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RYMinimumType.

property Joint.RZMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RZMaximumType.

property Joint.RZMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the RZMinimumType.

property Joint.XMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the XMaximumType.

property Joint.XMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the XMinimumType.

property Joint.YMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the YMaximumType.

property Joint.YMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the YMinimumType.

property Joint.ZMaximumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the ZMaximumType.

property Joint.ZMinimumType: Ansys.Mechanical.DataModel.Enums.JointStopType | None

Gets or sets the ZMinimumType.

property Joint.Type: Ansys.Mechanical.DataModel.Enums.JointType | None

Gets or sets the Type.

property Joint.MobileAppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the MobileAppliedBy.

property Joint.ReferenceAppliedBy: Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the ReferenceAppliedBy.

property Joint.Rotations: Ansys.Mechanical.DataModel.Enums.JointRotationDOFType | None

Gets or sets the Rotations.

property Joint.SolverElementType: Ansys.Mechanical.DataModel.Enums.JointSolverElementType | None

Gets or sets the SolverElementType.

property Joint.TranslationX: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationX.

property Joint.TranslationY: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationY.

property Joint.TranslationZ: Ansys.Mechanical.DataModel.Enums.FixedOrFree | None

Gets or sets the TranslationZ.

property Joint.MobileRelaxationMethod: System.Boolean | None

Gets or sets the MobileRelaxationMethod.

property Joint.ReferenceRelaxationMethod: System.Boolean | None

Gets or sets the ReferenceRelaxationMethod.

property Joint.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property Joint.SuppressedForSolve: System.Boolean | None

Gets the SuppressedForSolve.

property Joint.ElementCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the ElementCoordinateSystem.

property Joint.MobileCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the MobileCoordinateSystem.

property Joint.ReferenceCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the ReferenceCoordinateSystem.

property Joint.MobileLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the MobileLocation.

property Joint.CurveOrientationSurface: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the CurveOrientationSurface.

property Joint.ReferenceLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ReferenceLocation.

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

Gets the current DataModelObject’s category.

property Joint.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Joint.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Joint.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Joint.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Joint.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Joint.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property Joint.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Joint.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

Joint.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Joint.PromoteToRemotePoint() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

Joint.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

Joint.FlipReferenceMobile() → System.Void

Run the FlipReferenceMobile action.

Joint.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

Joint.Delete() → System.Void

Run the Delete action.

Joint.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

Joint.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]

Gets the list of children, filtered by type.

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

Creates a new child Comment.

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

Creates a new child Figure.

Joint.AddImage(filePath: System.String) → 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.

Joint.Activate() → System.Void

Activate the current object.

Joint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

Joint.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Joint.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Joint.PropertyByAPIName(name: System.String) → 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.

Joint.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Joint.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Joint.RemoveParameter(propName: System.String) → System.Void

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