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