`NodalDisplacement`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.NodalDisplacement#

Bases: object

Defines a NodalDisplacement.

Overview#

Methods

`GetActivateAtLoadStep`	GetActivateAtLoadStep method.
`SetActivateAtLoadStep`	SetActivateAtLoadStep method.
`GetComponentActivateAtLoadStep`	GetComponentActivateAtLoadStep method.
`SetComponentActivateAtLoadStep`	SetComponentActivateAtLoadStep method.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection 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

`InternalObject`	Gets the internal object. For advanced usage only.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`XComponent`	Gets the XComponent.
`YComponent`	Gets the YComponent.
`ZComponent`	Gets the ZComponent.
`RangeMaximum`	Gets or sets the RangeMaximum.
`RangeMinimum`	Gets or sets the RangeMinimum.
`PhaseAngle`	Gets or sets the PhaseAngle.
`DynamicRelaxationBehavior`	Gets or sets the DynamicRelaxationBehavior.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`IndependentVariable`	Gets or sets the IndependentVariable.
`ReverseDirectionForInverseSteps`	Gets or sets the ReverseDirectionForInverseSteps.
`CoordinateSystem`	Gets the CoordinateSystem.
`XYZFunctionCoordinateSystem`	Gets or sets the XYZFunctionCoordinateSystem.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`SharedRefBody`	Gets or sets the SharedRefBody.
`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 NodalDisplacement.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None: Gets the internal object. For advanced usage only.

property NodalDisplacement.NumberOfSegments: System.Int32 | None: Gets or sets the NumberOfSegments.

property NodalDisplacement.XComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the XComponent.

property NodalDisplacement.YComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the YComponent.

property NodalDisplacement.ZComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the ZComponent.

property NodalDisplacement.RangeMaximum: Ansys.Core.Units.Quantity | None: Gets or sets the RangeMaximum.

property NodalDisplacement.RangeMinimum: Ansys.Core.Units.Quantity | None: Gets or sets the RangeMinimum.

property NodalDisplacement.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseAngle.

property NodalDisplacement.DynamicRelaxationBehavior: Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None: Gets or sets the DynamicRelaxationBehavior.

property NodalDisplacement.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the GraphControlsXAxis.

property NodalDisplacement.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the IndependentVariable.

property NodalDisplacement.ReverseDirectionForInverseSteps: System.Boolean | None: Gets or sets the ReverseDirectionForInverseSteps.

property NodalDisplacement.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets the CoordinateSystem.

property NodalDisplacement.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the XYZFunctionCoordinateSystem.

property NodalDisplacement.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property NodalDisplacement.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property NodalDisplacement.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property NodalDisplacement.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None: Gets or sets the SharedRefBody.

property NodalDisplacement.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property NodalDisplacement.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property NodalDisplacement.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property NodalDisplacement.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property NodalDisplacement.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property NodalDisplacement.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property NodalDisplacement.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property NodalDisplacement.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

NodalDisplacement.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean: GetActivateAtLoadStep method.

NodalDisplacement.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetActivateAtLoadStep method.

NodalDisplacement.GetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32) → System.Boolean: GetComponentActivateAtLoadStep method.

NodalDisplacement.SetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetComponentActivateAtLoadStep method.

NodalDisplacement.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

NodalDisplacement.Delete() → System.Void: Run the Delete action.

NodalDisplacement.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

NodalDisplacement.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.

NodalDisplacement.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

NodalDisplacement.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

NodalDisplacement.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.

NodalDisplacement.Activate() → System.Void: Activate the current object.

NodalDisplacement.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

NodalDisplacement.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

NodalDisplacement.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

NodalDisplacement.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

NodalDisplacement.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

NodalDisplacement.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.

NodalDisplacement.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

NodalDisplacement.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

NodalDisplacement.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.