RSDisplacement
Last update: 14.01.2025
RSDisplacement
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.RSDisplacement
Bases: object
Defines a RSDisplacement.
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 |
---|---|
BoundaryCondition |
Gets or sets the BoundaryCondition. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Direction |
Gets or sets the Direction. |
Figures |
Gets the list of associated figures. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
LoadData |
Gets or sets the LoadData. |
MissingMassEffect |
Gets or sets the MissingMassEffect. |
MissingMassEffectZPA |
Gets or sets the MissingMassEffectZPA. |
Properties |
Gets the list of properties for this object. |
RigidResponseEffect |
Gets or sets the RigidResponseEffect. |
RigidResponseEffectFreqBegin |
Gets or sets the RigidResponseEffectFreqBegin. |
RigidResponseEffectFreqEnd |
Gets or sets the RigidResponseEffectFreqEnd. |
RigidResponseEffectType |
Gets or sets the RigidResponseEffectType. |
RigidResponseEffectZPA |
Gets or sets the RigidResponseEffectZPA. |
ScaleFactor |
Gets or sets the ScaleFactor. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property RSDisplacement.BoundaryCondition : Any | None
Gets or sets the BoundaryCondition.
property RSDisplacement.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property RSDisplacement.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property RSDisplacement.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property RSDisplacement.Direction : Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None
Gets or sets the Direction.
property RSDisplacement.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property RSDisplacement.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property RSDisplacement.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSRSLoadAuto | None
Gets the internal object. For advanced usage only.
property RSDisplacement.LoadData : Ansys.ACT.Mechanical.Fields.Field | None
Gets or sets the LoadData.
property RSDisplacement.MissingMassEffect : bool | None
Gets or sets the MissingMassEffect.
property RSDisplacement.MissingMassEffectZPA : Ansys.Core.Units.Quantity | None
Gets or sets the MissingMassEffectZPA.
property RSDisplacement.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property RSDisplacement.RigidResponseEffect : bool | None
Gets or sets the RigidResponseEffect.
property RSDisplacement.RigidResponseEffectFreqBegin : Ansys.Core.Units.Quantity | None
Gets or sets the RigidResponseEffectFreqBegin.
property RSDisplacement.RigidResponseEffectFreqEnd : Ansys.Core.Units.Quantity | None
Gets or sets the RigidResponseEffectFreqEnd.
property RSDisplacement.RigidResponseEffectType : Ansys.Mechanical.DataModel.Enums.RigidResponseEffectType | None
Gets or sets the RigidResponseEffectType.
property RSDisplacement.RigidResponseEffectZPA : Ansys.Core.Units.Quantity | None
Gets or sets the RigidResponseEffectZPA.
property RSDisplacement.ScaleFactor : float | None
Gets or sets the ScaleFactor.
property RSDisplacement.Suppressed : bool | None
Gets or sets the Suppressed.
property RSDisplacement.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
RSDisplacement.Activate()
Activate the current object.
RSDisplacement.AddComment()
Creates a new child Comment.
RSDisplacement.AddFigure()
Creates a new child Figure.
RSDisplacement.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.
RSDisplacement.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
RSDisplacement.CreateParameter(propName: str)
Creates a new parameter for a Property.
RSDisplacement.Delete()
Run the Delete action.
RSDisplacement.Duplicate()
Creates a copy of the current DataModelObject.
RSDisplacement.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
RSDisplacement.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
RSDisplacement.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
RSDisplacement.GroupSimilarObjects()
Run the GroupSimilarObjects action.
RSDisplacement.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.
RSDisplacement.PropertyByName(name: str)
Get a property by its unique name.
RSDisplacement.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.