Skip to main content

Mechanical scripting interface

AcousticSurfaceVelocity

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticSurfaceVelocity

Bases: object

Defines a AcousticSurfaceVelocity.

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.
GetChildren Gets the list of children, filtered by type.
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.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefineBy Gets or sets the DefineBy.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Magnitude Gets or sets the Magnitude.
PhaseAngle Gets or sets the PhaseAngle.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
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 or sets the XComponent.
XPhaseAngle Gets or sets the XPhaseAngle.
YComponent Gets or sets the YComponent.
YPhaseAngle Gets or sets the YPhaseAngle.
ZComponent Gets or sets the ZComponent.
ZPhaseAngle Gets or sets the ZPhaseAngle.

Property detail

property AcousticSurfaceVelocity.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property AcousticSurfaceVelocity.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property AcousticSurfaceVelocity.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

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

Gets or sets the DefineBy.

property AcousticSurfaceVelocity.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property AcousticSurfaceVelocity.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the Magnitude.

property AcousticSurfaceVelocity.PhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the PhaseAngle.

property AcousticSurfaceVelocity.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property AcousticSurfaceVelocity.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property AcousticSurfaceVelocity.Suppressed : bool | None

Gets or sets the Suppressed.

property AcousticSurfaceVelocity.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

property AcousticSurfaceVelocity.XComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the XComponent.

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

Gets or sets the XPhaseAngle.

property AcousticSurfaceVelocity.YComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the YComponent.

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

Gets or sets the YPhaseAngle.

property AcousticSurfaceVelocity.ZComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the ZComponent.

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

Gets or sets the ZPhaseAngle.

Method detail

AcousticSurfaceVelocity.Activate()

Activate the current object.

AcousticSurfaceVelocity.AddComment()

Creates a new child Comment.

AcousticSurfaceVelocity.AddFigure()

Creates a new child Figure.

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

AcousticSurfaceVelocity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

AcousticSurfaceVelocity.CreateParameter(propName: str)

Creates a new parameter for a Property.

AcousticSurfaceVelocity.Delete()

Run the Delete action.

AcousticSurfaceVelocity.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

AcousticSurfaceVelocity.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

AcousticSurfaceVelocity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

AcousticSurfaceVelocity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

AcousticSurfaceVelocity.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

AcousticSurfaceVelocity.PropertyByName(name: str)

Get a property by its unique name.

AcousticSurfaceVelocity.RemoveParameter(propName: str)

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