`Velocity`#

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

Bases: object

Defines a Velocity.

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 velocity 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.
`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 velocity is active at the specified load step.
`SetComponentActivateAtLoadStep`	SetComponentActivateAtLoadStep method.
`ToString`	ToString method.

Properties

`AttachedRefs`	AttachedRefs property.
`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.
`DynamicRelaxationBehavior`	Gets or sets the DynamicRelaxationBehavior.
`Figures`	Gets the list of associated figures.
`GroupingFolder`	GroupingFolder property.
`IconName`	IconName property.
`Images`	Gets the list of associated images.
`ImportableObjectSourceId`	ImportableObjectSourceId property.
`InternalObject`	Gets the internal object. For advanced usage only.
`Location`	Gets or sets the Location.
`Name`	Name property.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`ObjectId`	ObjectId property.
`ObjectState`	ObjectState property.
`ObjectTags`	ObjectTags property.
`Parent`	Parent property.
`Properties`	Gets the list of properties for this object.
`ReadOnly`	Gets or sets the ReadOnly.
`SharedRefBody`	Gets or sets the SharedRefBody.
`State`	State property.
`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.
`YComponent`	Gets the YComponent.
`ZComponent`	Gets the ZComponent.

Property detail#

property Velocity.AttachedRefs: List[int] | None#: AttachedRefs property.

property Velocity.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property Velocity.ClsId: int | None#: ClsId property.

property Velocity.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property Velocity.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the CoordinateSystem.

property Velocity.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property Velocity.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None#: Gets or sets the DefineBy.

property Velocity.DynamicRelaxationBehavior: Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None#: Gets or sets the DynamicRelaxationBehavior.

property Velocity.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property Velocity.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property Velocity.IconName: str | None#: IconName property.

property Velocity.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property Velocity.ImportableObjectSourceId: str | None#: ImportableObjectSourceId property.

property Velocity.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#: Gets the internal object. For advanced usage only.

property Velocity.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the Location.

property Velocity.Name: str | None#: Name property.

property Velocity.NumberOfSegments: int | None#: Gets or sets the NumberOfSegments.

property Velocity.ObjectId: int | None#: ObjectId property.

property Velocity.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

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

property Velocity.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

property Velocity.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property Velocity.ReadOnly: bool | None#: Gets or sets the ReadOnly.

property Velocity.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#: Gets or sets the SharedRefBody.

property Velocity.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

property Velocity.Suppressed: bool | None#: Gets or sets the Suppressed.

property Velocity.TransferableObjectId: str | None#: TransferableObjectId property.

property Velocity.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

property Velocity.XComponent: Ansys.ACT.Mechanical.Fields.Field | None#: Gets the XComponent.

property Velocity.YComponent: Ansys.ACT.Mechanical.Fields.Field | None#: Gets the YComponent.

property Velocity.ZComponent: Ansys.ACT.Mechanical.Fields.Field | None#: Gets the ZComponent.

Method detail#

Velocity.Activate() → None#: Activate the current object.

Velocity.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

Velocity.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

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

Velocity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

Velocity.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

Velocity.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

Velocity.Delete() → None#: Run the Delete action.

Velocity.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

Velocity.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

Velocity.GetAPIName(dispId: int) → str#: Property name bound to dispId.

Velocity.GetActivateAtLoadStep(stepNumber: int) → bool#: Gets whether the velocity is active at the specified load step.

Velocity.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

Velocity.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

Velocity.GetComponentActivateAtLoadStep(component: str, stepNumber: int) → bool#: GetComponentActivateAtLoadStep method.

Velocity.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

Velocity.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

Velocity.GetHashCode() → int#: GetHashCode method.

Velocity.GetIconFile() → System.Byte#: GetIconFile method.

Velocity.GetLifetimeService() → Any#: GetLifetimeService method.

Velocity.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

Velocity.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

Velocity.GetPath() → str#: GetPath method.

Velocity.GetPropertyName(dispId: int) → str#: GetPropertyName method.

Velocity.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

Velocity.GetType() → type#: GetType method.

Velocity.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

Velocity.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

Velocity.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

Velocity.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

Velocity.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

Velocity.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

Velocity.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

Velocity.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#: Run the PromoteToNamedSelection action.

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

Velocity.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

Velocity.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

Velocity.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

Velocity.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None#: Sets whether the velocity is active at the specified load step.

Velocity.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool) → None#: SetComponentActivateAtLoadStep method.

Velocity.ToString() → str#: ToString method.

Velocity#

Overview#

Property detail#

Method detail#

`Velocity`#