Skip to main content

Mechanical scripting interface

ImportedVelocity

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedVelocity

Bases: object

Defines a ImportedVelocity.

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.
AddMappingValidation Creates a new MappingValidation
ClearGeneratedData Run the ClearGeneratedData action.
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.
ExportToTextFile Run the ExportToTextFile action.
GetActivateAtLoadStep Gets whether the imported velocity is active at the specified load step.
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.
Import Import.
ImportLoad Run the ImportLoad action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
ReloadConfiguration Reload the Imported Load’s setup from its associated configuration file (if available).
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep Sets whether the imported velocity is active at the specified load step.

Properties

Name Description
Algorithm Algorithm property.
ApplyAs This controls how the imported load is applied, either as a boundary condition or an initial condition.
BoundingBoxTolerance BoundingBoxTolerance property.
Children Gets the list of children.
Comments Gets the list of associated comments.
CreateNameSelectionForMappedNodes CreateNameSelectionForMappedNodes property.
CreateNameSelectionForOutsideNodes CreateNameSelectionForOutsideNodes property.
CreateNameSelectionForUnmappedNodes CreateNameSelectionForUnmappedNodes property.
CutoffFrequency Gets or sets the CutoffFrequency.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayInteriorPoints DisplayInteriorPoints property.
DisplayProjectionPlane DisplayProjectionPlane property.
DisplaySourcePointIds DisplaySourcePointIds property.
DisplaySourcePoints DisplaySourcePoints property.
ExtrapolationTolerancePercent ExtrapolationTolerancePercent property.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Interpolation Interpolation property.
KrigingCorrelationFunction KrigingCorrelationFunction property.
KrigingPolynom KrigingPolynom property.
Limit Limit property.
Location Gets or sets the Location.
MappedData Gets or sets the MappedData.
MappedNodesName MappedNodesName property.
Mapping Mapping property.
MappingControl MappingControl property.
MaxOutsideDistance MaxOutsideDistance property.
MaximumTimeRange Gets or sets the MaximumTimeRange.
Method Method property.
MinimumTimeRange Gets or sets the MinimumTimeRange.
NumberOfPoints NumberOfPoints property.
OrientationRealignment OrientationRealignment property.
OutsideDistanceCheck OutsideDistanceCheck property.
OutsideNodesName OutsideNodesName property.
OutsideOption OutsideOption property.
Pinball Pinball property.
Projection Projection property.
Properties Gets the list of properties for this object.
RigidBodyTransformationType RigidBodyTransformationType property.
RigidTransformSourceCoordinateSystem RigidTransformSourceCoordinateSystem property.
RigidTransformTargetCoordinateSystem RigidTransformTargetCoordinateSystem property.
SharedRefBody Gets or sets the SharedRefBody.
ShellThicknessFactor ShellThicknessFactor property.
SourceMaximum SourceMaximum property.
SourceMinimum SourceMinimum property.
SourceTimeDefinitionType Gets or sets the SourceTimeDefinitionType.
Suppressed Gets or sets the Suppressed.
UnmappedNodesName UnmappedNodesName property.
VariableType VariableType property.
VisibleProperties Gets the list of properties that are visible for this object.
Weighting Weighting property.
WindowType Gets or sets the WindowType.

Property detail

property ImportedVelocity.Algorithm : Ansys.Mechanical.DataModel.Enums.MappingAlgorithm | None

Algorithm property.

property ImportedVelocity.ApplyAs : Ansys.Mechanical.DataModel.Enums.ExternalLoadApplicationType | None

This controls how the imported load is applied, either as a boundary condition or an initial condition.

property ImportedVelocity.BoundingBoxTolerance : Ansys.Core.Units.Quantity | None

BoundingBoxTolerance property.

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

Gets the list of children.

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

Gets the list of associated comments.

property ImportedVelocity.CreateNameSelectionForMappedNodes : bool | None

CreateNameSelectionForMappedNodes property.

property ImportedVelocity.CreateNameSelectionForOutsideNodes : bool | None

CreateNameSelectionForOutsideNodes property.

property ImportedVelocity.CreateNameSelectionForUnmappedNodes : bool | None

CreateNameSelectionForUnmappedNodes property.

property ImportedVelocity.CutoffFrequency : float | None

Gets or sets the CutoffFrequency.

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

Gets the current DataModelObject’s category.

property ImportedVelocity.DisplayInteriorPoints : bool | None

DisplayInteriorPoints property.

property ImportedVelocity.DisplayProjectionPlane : bool | None

DisplayProjectionPlane property.

property ImportedVelocity.DisplaySourcePointIds : bool | None

DisplaySourcePointIds property.

property ImportedVelocity.DisplaySourcePoints : bool | None

DisplaySourcePoints property.

property ImportedVelocity.ExtrapolationTolerancePercent : float | None

ExtrapolationTolerancePercent property.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ImportedVelocity.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSExternalLoadAuto | None

Gets the internal object. For advanced usage only.

property ImportedVelocity.Interpolation : Ansys.Mechanical.DataModel.Enums.InterpolationType | None

Interpolation property.

property ImportedVelocity.KrigingCorrelationFunction : Ansys.Mechanical.DataModel.Enums.KrigingCorrFuncType | None

KrigingCorrelationFunction property.

property ImportedVelocity.KrigingPolynom : Ansys.Mechanical.DataModel.Enums.KrigingPolynomType | None

KrigingPolynom property.

property ImportedVelocity.Limit : int | None

Limit property.

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

Gets or sets the Location.

property ImportedVelocity.MappedData : Ansys.Mechanical.DataModel.Enums.MappedData | None

Gets or sets the MappedData.

property ImportedVelocity.MappedNodesName : str | None

MappedNodesName property.

property ImportedVelocity.Mapping : Ansys.Mechanical.DataModel.Enums.MappingInterpolationType | None

Mapping property.

property ImportedVelocity.MappingControl : Ansys.Mechanical.DataModel.Enums.MappingControlType | None

MappingControl property.

property ImportedVelocity.MaxOutsideDistance : Ansys.Core.Units.Quantity | None

MaxOutsideDistance property.

property ImportedVelocity.MaximumTimeRange : float | None

Gets or sets the MaximumTimeRange.

property ImportedVelocity.Method : Ansys.Mechanical.DataModel.Enums.MappingMethod | None

Method property.

property ImportedVelocity.MinimumTimeRange : float | None

Gets or sets the MinimumTimeRange.

property ImportedVelocity.NumberOfPoints : int | None

NumberOfPoints property.

property ImportedVelocity.OrientationRealignment : bool | None

OrientationRealignment property.

property ImportedVelocity.OutsideDistanceCheck : bool | None

OutsideDistanceCheck property.

property ImportedVelocity.OutsideNodesName : str | None

OutsideNodesName property.

property ImportedVelocity.OutsideOption : Ansys.Mechanical.DataModel.Enums.MappingOutsideOption | None

OutsideOption property.

property ImportedVelocity.Pinball : Ansys.Core.Units.Quantity | None

Pinball property.

property ImportedVelocity.Projection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Projection property.

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

Gets the list of properties for this object.

property ImportedVelocity.RigidBodyTransformationType : Ansys.Mechanical.DataModel.Enums.RigidBodyTransformationType | None

RigidBodyTransformationType property.

property ImportedVelocity.RigidTransformSourceCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformSourceCoordinateSystem property.

property ImportedVelocity.RigidTransformTargetCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformTargetCoordinateSystem property.

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

Gets or sets the SharedRefBody.

property ImportedVelocity.ShellThicknessFactor : float | None

ShellThicknessFactor property.

property ImportedVelocity.SourceMaximum : Ansys.Core.Units.Quantity | None

SourceMaximum property.

property ImportedVelocity.SourceMinimum : Ansys.Core.Units.Quantity | None

SourceMinimum property.

property ImportedVelocity.SourceTimeDefinitionType : Ansys.Mechanical.DataModel.Enums.SourceTimeDefinitionType | None

Gets or sets the SourceTimeDefinitionType.

property ImportedVelocity.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedVelocity.UnmappedNodesName : str | None

UnmappedNodesName property.

property ImportedVelocity.VariableType : Ansys.Mechanical.DataModel.Enums.MappingVariableType | None

VariableType property.

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

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

property ImportedVelocity.Weighting : Ansys.Mechanical.DataModel.Enums.WeightingType | None

Weighting property.

property ImportedVelocity.WindowType : Ansys.Mechanical.DataModel.Enums.WindowType | None

Gets or sets the WindowType.

Method detail

ImportedVelocity.Activate()

Activate the current object.

ImportedVelocity.AddComment()

Creates a new child Comment.

ImportedVelocity.AddFigure()

Creates a new child Figure.

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

ImportedVelocity.AddMappingValidation()

Creates a new MappingValidation

ImportedVelocity.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ImportedVelocity.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImportedVelocity.Delete()

Run the Delete action.

ImportedVelocity.Duplicate()

Creates a copy of the current DataModelObject.

ImportedVelocity.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

ImportedVelocity.GetActivateAtLoadStep(stepNumber: int)

Gets whether the imported velocity is active at the specified load step.

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

Gets the list of children, filtered by type.

ImportedVelocity.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImportedVelocity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImportedVelocity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImportedVelocity.Import()

Import.

ImportedVelocity.ImportLoad()

Run the ImportLoad action.

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

ImportedVelocity.PropertyByName(name: str)

Get a property by its unique name.

ImportedVelocity.ReloadConfiguration()

Reload the Imported Load’s setup from its associated configuration file (if available).

ImportedVelocity.RemoveParameter(propName: str)

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

ImportedVelocity.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

Sets whether the imported velocity is active at the specified load step.