Displacement
Last update: 14.01.2025
Displacement
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Displacement
Bases: object
Defines a Displacement.
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. |
GetActivateAtLoadStep |
Gets whether the displacement is active at the specified load step. |
GetChildren |
Gets the list of children, filtered by type. |
GetComponentActivateAtLoadStep |
GetComponentActivateAtLoadStep method. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
PromoteToNamedSelection |
Run the PromoteToNamedSelection 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. |
SetActivateAtLoadStep |
Sets whether the displacement is active at the specified load step. |
SetComponentActivateAtLoadStep |
SetComponentActivateAtLoadStep method. |
Properties
Name | Description |
---|---|
AbsoluteResult |
Gets or sets the AbsoluteResult. |
BaseExcitation |
Gets or sets the BaseExcitation. |
BoundaryCondition |
Gets or sets the BoundaryCondition. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
CoordinateSystem |
Gets or sets the CoordinateSystem. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
DefineBy |
Gets or sets the DefineBy. |
Direction |
Gets or sets the Direction. |
Distance |
Gets the Distance. |
DynamicRelaxationBehavior |
Gets or sets the DynamicRelaxationBehavior. |
Figures |
Gets the list of associated figures. |
GraphControlsXAxis |
Gets or sets the GraphControlsXAxis. |
Images |
Gets the list of associated images. |
IndependentVariable |
Gets or sets the IndependentVariable. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
MagnitudeImag |
Gets the MagnitudeImag. |
NumberOfSegments |
Gets or sets the NumberOfSegments. |
PhaseAngle |
Gets the PhaseAngle. |
Properties |
Gets the list of properties for this object. |
RangeMaximum |
Gets or sets the RangeMaximum. |
RangeMinimum |
Gets or sets the RangeMinimum. |
ReadOnly |
Gets or sets the ReadOnly. |
ReverseDirectionForInverseSteps |
Gets or sets the ReverseDirectionForInverseSteps. |
RpmSelection |
Gets or sets the RPMSelection. |
SharedRefBody |
Gets or sets the SharedRefBody. |
StepSelection |
Gets or sets the StepSelection. |
StepVarying |
Gets or sets the StepVarying. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
XComponent |
Gets the XComponent. |
XComponentImag |
Gets the XComponentImag. |
XPhaseAngle |
Gets the XPhaseAngle. |
XYZFunctionCoordinateSystem |
Gets or sets the XYZFunctionCoordinateSystem. |
YComponent |
Gets the YComponent. |
YComponentImag |
Gets the YComponentImag. |
YPhaseAngle |
Gets the YPhaseAngle. |
ZComponent |
Gets the ZComponent. |
ZComponentImag |
Gets the ZComponentImag. |
ZPhaseAngle |
Gets the ZPhaseAngle. |
Property detail
property Displacement.AbsoluteResult : bool | None
Gets or sets the AbsoluteResult.
property Displacement.BaseExcitation : bool | None
Gets or sets the BaseExcitation.
property Displacement.BoundaryCondition : Any | None
Gets or sets the BoundaryCondition.
property Displacement.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Displacement.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Displacement.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the CoordinateSystem.
property Displacement.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Displacement.DefineBy : Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None
Gets or sets the DefineBy.
property Displacement.Direction : Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None
Gets or sets the Direction.
property Displacement.Distance : Ansys.ACT.Mechanical.Fields.Field | None
Gets the Distance.
property Displacement.DynamicRelaxationBehavior : Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None
Gets or sets the DynamicRelaxationBehavior.
property Displacement.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property Displacement.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None
Gets or sets the GraphControlsXAxis.
property Displacement.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Displacement.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None
Gets or sets the IndependentVariable.
property Displacement.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None
Gets the internal object. For advanced usage only.
property Displacement.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property Displacement.MagnitudeImag : Ansys.ACT.Mechanical.Fields.Field | None
Gets the MagnitudeImag.
property Displacement.NumberOfSegments : int | None
Gets or sets the NumberOfSegments.
property Displacement.PhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None
Gets the PhaseAngle.
property Displacement.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Displacement.RangeMaximum : Ansys.Core.Units.Quantity | None
Gets or sets the RangeMaximum.
property Displacement.RangeMinimum : Ansys.Core.Units.Quantity | None
Gets or sets the RangeMinimum.
property Displacement.ReadOnly : bool | None
Gets or sets the ReadOnly.
property Displacement.ReverseDirectionForInverseSteps : bool | None
Gets or sets the ReverseDirectionForInverseSteps.
property Displacement.RpmSelection : Ansys.Core.Units.Quantity | None
Gets or sets the RPMSelection.
property Displacement.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None
Gets or sets the SharedRefBody.
property Displacement.StepSelection : int | None
Gets or sets the StepSelection.
property Displacement.StepVarying : Ansys.Mechanical.DataModel.Enums.StepVarying | None
Gets or sets the StepVarying.
property Displacement.Suppressed : bool | None
Gets or sets the Suppressed.
property Displacement.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
property Displacement.XComponent : Ansys.ACT.Mechanical.Fields.Field | None
Gets the XComponent.
property Displacement.XComponentImag : Ansys.ACT.Mechanical.Fields.Field | None
Gets the XComponentImag.
property Displacement.XPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None
Gets the XPhaseAngle.
property Displacement.XYZFunctionCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the XYZFunctionCoordinateSystem.
property Displacement.YComponent : Ansys.ACT.Mechanical.Fields.Field | None
Gets the YComponent.
property Displacement.YComponentImag : Ansys.ACT.Mechanical.Fields.Field | None
Gets the YComponentImag.
property Displacement.YPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None
Gets the YPhaseAngle.
property Displacement.ZComponent : Ansys.ACT.Mechanical.Fields.Field | None
Gets the ZComponent.
property Displacement.ZComponentImag : Ansys.ACT.Mechanical.Fields.Field | None
Gets the ZComponentImag.
property Displacement.ZPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None
Gets the ZPhaseAngle.
Method detail
Displacement.Activate()
Activate the current object.
Displacement.AddComment()
Creates a new child Comment.
Displacement.AddFigure()
Creates a new child Figure.
Displacement.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.
Displacement.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
Displacement.CreateParameter(propName: str)
Creates a new parameter for a Property.
Displacement.Delete()
Run the Delete action.
Displacement.Duplicate()
Creates a copy of the current DataModelObject.
Displacement.GetActivateAtLoadStep(stepNumber: int)
Gets whether the displacement is active at the specified load step.
Displacement.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Displacement.GetComponentActivateAtLoadStep(component: str, stepNumber: int)
GetComponentActivateAtLoadStep method.
Displacement.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Displacement.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Displacement.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Displacement.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
Displacement.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.
Displacement.PropertyByName(name: str)
Get a property by its unique name.
Displacement.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
Displacement.SetActivateAtLoadStep(stepNumber: int, bActive: bool)
Sets whether the displacement is active at the specified load step.
Displacement.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)
SetComponentActivateAtLoadStep method.