Displacement
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Displacement#
Bases:
object
Defines a Displacement.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
GetActivateAtLoadStep method. |
|
Gets the list of children, filtered by type. |
|
GetComponentActivateAtLoadStep method. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Run the PromoteToNamedSelection action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
SetActivateAtLoadStep method. |
|
SetComponentActivateAtLoadStep method. |
Gets or sets the AbsoluteResult. |
|
Gets or sets the BaseExcitation. |
|
Gets or sets the BoundaryCondition. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets or sets the CoordinateSystem. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the DefineBy. |
|
Gets or sets the Direction. |
|
Gets the Distance. |
|
Gets or sets the DynamicRelaxationBehavior. |
|
Gets the list of associated figures. |
|
Gets or sets the GraphControlsXAxis. |
|
Gets the list of associated images. |
|
Gets or sets the IndependentVariable. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the Location. |
|
Gets the MagnitudeImag. |
|
Gets or sets the NumberOfSegments. |
|
Gets the PhaseAngle. |
|
Gets the list of properties for this object. |
|
Gets or sets the RangeMaximum. |
|
Gets or sets the RangeMinimum. |
|
Gets or sets the ReadOnly. |
|
Gets or sets the ReverseDirectionForInverseSteps. |
|
Gets or sets the RpmSelection. |
|
Gets or sets the SharedRefBody. |
|
Gets or sets the StepSelection. |
|
Gets or sets the StepVarying. |
|
Gets or sets the Suppressed. |
|
Gets the list of properties that are visible for this object. |
|
Gets the XComponent. |
|
Gets the XComponentImag. |
|
Gets the XPhaseAngle. |
|
Gets or sets the XYZFunctionCoordinateSystem. |
|
Gets the YComponent. |
|
Gets the YComponentImag. |
|
Gets the YPhaseAngle. |
|
Gets the ZComponent. |
|
Gets the ZComponentImag. |
|
Gets the ZPhaseAngle. |
Property detail#
- 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.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.ReverseDirectionForInverseSteps: bool | None#
Gets or sets the ReverseDirectionForInverseSteps.
- property Displacement.RpmSelection: Ansys.Core.Units.Quantity | None#
Gets or sets the RpmSelection.
Gets or sets the SharedRefBody.
- property Displacement.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None#
Gets or sets the StepVarying.
- 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.AddComment() Ansys.ACT.Automation.Mechanical.Comment #
Creates a new child Comment.
- Displacement.AddFigure() Ansys.ACT.Automation.Mechanical.Figure #
Creates a new child Figure.
- Displacement.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.
- Displacement.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None #
Copies all visible properties from this object to another.
- Displacement.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Creates a new parameter for a Property.
- Displacement.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- Displacement.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType] #
Gets the list of children, filtered by type.
- Displacement.GetComponentActivateAtLoadStep(component: str, stepNumber: int) bool #
GetComponentActivateAtLoadStep method.
- Displacement.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Gets the parameter corresponding to the given property.
- Displacement.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
- Displacement.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection] #
Run the PromoteToNamedSelection action.
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) Ansys.ACT.Automation.Mechanical.Property #
Get a property by its unique name.
- Displacement.RemoveParameter(propName: str) None #
Removes the parameter from the parameter set corresponding to the given property.