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