Moment

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Moment(internalObject: Any)

Bases: object

Defines a Moment.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetActivateAtLoadStep	Gets whether the moment is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
ToString	ToString method.

Properties

ApplyToRigidBodyPilotNode	Gets or sets the ApplyToRigidBodyPilotNode.
AttachedRefs	AttachedRefs property.
BeamMaterial	Gets or sets the BeamMaterial.
BeamRadius	Gets or sets the BeamRadius.
Behavior	Gets or sets the Behavior.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
HarmonicIndex	Gets or sets the HarmonicIndex.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IndependentVariable	Gets or sets the IndependentVariable.
InternalObject	Gets the internal object. For advanced usage only.
LoadStepVarying	Gets or sets the LoadStepVarying.
LoadVectorAssignment
LoadVectorNumber
LoadVectorNumberImaginary
LoadVectorNumberX
LoadVectorNumberXImaginary
LoadVectorNumberY
LoadVectorNumberYImaginary
LoadVectorNumberZ
LoadVectorNumberZImaginary
LoadingApplicationType	Gets or sets the LoadingApplicationType.
Location	Gets or sets the Geometry.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
Name	Name property.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
RpmVarying	Gets or sets the RpmVarying.
SectorNumber	Gets or sets the SectorNumber.
SharedRefBody	Gets or sets the SharedRefBody.
State	State property.
StepSelection	Gets or sets the StepSelection.
StepVarying	Gets or sets the StepVarying.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
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.ApplyToRigidBodyPilotNode: bool | None

Gets or sets the ApplyToRigidBodyPilotNode.

property Moment.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the HarmonicIndex.

property Moment.IconName: str | None

IconName property.

property Moment.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Moment.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.LoadStepVarying: bool | None

Gets or sets the LoadStepVarying.

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

property Moment.LoadVectorNumber: int | None

property Moment.LoadVectorNumberImaginary: int | None

property Moment.LoadVectorNumberX: int | None

property Moment.LoadVectorNumberXImaginary: int | None

property Moment.LoadVectorNumberY: int | None

property Moment.LoadVectorNumberYImaginary: int | None

property Moment.LoadVectorNumberZ: int | None

property Moment.LoadVectorNumberZImaginary: int | None

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.Name: str | None

Name property.

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.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property Moment.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Moment.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.RpmVarying: bool | None

Gets or sets the RpmVarying.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.TransferableObjectId: str | None

TransferableObjectId property.

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() → None

Activate the current object.

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

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

Copies all visible properties from this object to another.

Moment.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

Moment.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Moment.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Moment.GetAPIName(dispId: int) → str

Property name bound to dispId.

Moment.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the moment is active at the specified load step.

Moment.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

Moment.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Moment.GetComponentActivateAtLoadStep(component: str, stepNumber: int) → bool

GetComponentActivateAtLoadStep method.

Moment.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Moment.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Moment.GetHashCode() → int

GetHashCode method.

Moment.GetIconFile() → System.Byte

GetIconFile method.

Moment.GetLifetimeService() → Any

GetLifetimeService method.

Moment.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Moment.GetPath() → str

GetPath method.

Moment.GetPropertyName(dispId: int) → str

GetPropertyName method.

Moment.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Moment.GetType() → type

GetType method.

Moment.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Moment.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Moment.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Moment.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Moment.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Moment.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

Moment.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Moment.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

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

Moment.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

Moment.RemoveParameter(propName: str) → None

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

Moment.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None

Sets whether the moment is active at the specified load step.

Moment.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool) → None

SetComponentActivateAtLoadStep method.

Moment.ToString() → str

ToString method.