Moment

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Moment

Bases: object

Defines a Moment.

Overview

Methods

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

Direction	Gets or sets the Direction.
RemotePoint	Gets the remote point associated to the point mass.
Location	Gets or sets the Geometry.
StepSelection	Gets or sets the StepSelection.
InternalObject	Gets the internal object. For advanced usage only.
BeamMaterial	Gets or sets the BeamMaterial.
NumberOfSegments	Gets or sets the NumberOfSegments.
XComponent	Gets the XComponent.
XComponentImag	Gets the XComponentImag.
YComponent	Gets the YComponent.
YComponentImag	Gets the YComponentImag.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets the ZComponentImag.
HarmonicIndex	Gets or sets the HarmonicIndex.
SectorNumber	Gets or sets the SectorNumber.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
PhaseAngle	Gets the PhaseAngle.
XPhaseAngle	Gets the XPhaseAngle.
YPhaseAngle	Gets the YPhaseAngle.
ZPhaseAngle	Gets the ZPhaseAngle.
BeamRadius	Gets or sets the BeamRadius.
PinballRegion	Gets or sets the PinballRegion.
RpmSelection	Gets or sets the RpmSelection.
Behavior	Gets or sets the Behavior.
DefineBy	Gets or sets the DefineBy.
LoadingApplicationType	Gets or sets the LoadingApplicationType.
StepVarying	Gets or sets the StepVarying.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
IndependentVariable	Gets or sets the IndependentVariable.
CoordinateSystem	Gets or sets the CoordinateSystem.
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 Moment.Direction: Ansys.ACT.Math.Vector3D | None

Gets or sets the Direction.

property Moment.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets the remote point associated to the point mass.

property Moment.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Geometry.

property Moment.StepSelection: System.Int32 | None

Gets or sets the StepSelection.

property Moment.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

property Moment.BeamMaterial: System.String | None

Gets or sets the BeamMaterial.

property Moment.NumberOfSegments: System.Int32 | None

Gets or sets the NumberOfSegments.

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.YComponent: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponent.

property Moment.YComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponentImag.

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.HarmonicIndex: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the HarmonicIndex.

property Moment.SectorNumber: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the SectorNumber.

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.PhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the PhaseAngle.

property Moment.XPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the XPhaseAngle.

property Moment.YPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the YPhaseAngle.

property Moment.ZPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZPhaseAngle.

property Moment.BeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the BeamRadius.

property Moment.PinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the PinballRegion.

property Moment.RpmSelection: Ansys.Core.Units.Quantity | None

Gets or sets the RpmSelection.

property Moment.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the Behavior.

property Moment.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets or sets the DefineBy.

property Moment.LoadingApplicationType: Ansys.Mechanical.DataModel.Enums.LoadingApplicationType | None

Gets or sets the LoadingApplicationType.

property Moment.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None

Gets or sets the StepVarying.

property Moment.NonCyclicLoadingType: Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None

Gets or sets the NonCyclicLoadingType.

property Moment.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

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.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property Moment.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property Moment.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Moment.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Moment.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Moment.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Moment.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Moment.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property Moment.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Moment.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

Moment.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean

GetActivateAtLoadStep method.

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

SetActivateAtLoadStep method.

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

GetComponentActivateAtLoadStep method.

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

SetComponentActivateAtLoadStep method.

Moment.PromoteToRemotePoint() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

Moment.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Moment.Delete() → System.Void

Run the Delete action.

Moment.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

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

Moment.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Moment.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

Moment.Activate() → System.Void

Activate the current object.

Moment.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

Moment.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Moment.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

Moment.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Moment.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

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

Moment.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Moment.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Moment.RemoveParameter(propName: System.String) → System.Void

Removes the parameter from the parameter set corresponding to the given property.