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