StressFrequencyResponse#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.StressFrequencyResponse(internalObject: Any)#

Bases: object

Defines a StressFrequencyResponse.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddImage

Creates a new child Image.

ClearGeneratedData

Run the ClearGeneratedData action.

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.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

GetAPIName

Property name bound to dispId.

GetAllProperties

GetAllProperties method.

GetChildren

Gets the list of children, filtered by type.

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.

GetQuantityName

GetQuantityName method.

GetQuantityNameFromType

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

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.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

ToString

ToString method.

AccelerationType

Gets or sets the AccelerationType.

BoundaryCondition

Gets or sets the BoundaryCondition.

ChartDimensions

Gets or sets the Chart Dimensions

ChartViewingStyle

Gets or sets the ChartViewingStyle.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the CoordinateSystem. Accepts/Returns None if it is the Solution Coordinate System.

CurvesAppearanceDisplay

Gets or sets the CurvesAppearanceDisplay.

CutFrequency

Gets or sets the CutFrequency.

DataModelObjectCategory

Gets the current DataModelObject's category.

DeformationType

Gets or sets the DeformationType.

DisplayOrder

Gets or sets the DisplayOrder.

DisplayPanel

Gets or sets the DisplayPanel.

DpfEvaluation

Gets or sets the DpfEvaluation.

Duration

Gets or sets the Duration.

EnhancedTracking

Gets the EnhancedTracking.

FilterMaximum

Gets the FilterMaximum.

FilterMinimum

Gets the FilterMinimum.

FilterType

Gets or sets the FilterType.

FrequencyAtMaximumAmplitude

Gets the FrequencyAtMaximumAmplitude.

FrequencySelection

Gets or sets the FrequencySelection.

GeometrySelectionString

Gets or sets the GeometrySelectionString.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Images

Gets the list of associated images.

ImaginaryAtMaximumAmplitude

Gets the ImaginaryAtMaximumAmplitude.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

Maximum

Gets the Maximum.

MaximumAmplitude

Gets the MaximumAmplitude.

MaximumFrequency

Gets or sets the MaximumFrequency.

Minimum

Gets the Minimum.

MinimumFrequency

Gets or sets the MinimumFrequency.

Name

Name property.

NormalOrientation

Gets or sets the NormalOrientation.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

OrderSelection

Gets or sets the OrderSelection.

OrdersToDisplay

Gets or sets the OrdersToDisplay.

PanelContribution

Gets or sets the PanelContribution.

PanelsToDisplay

Gets or sets the PanelsToDisplay.

Parent

Parent property.

PhaseAngle

Gets the PhaseAngle.

Properties

Gets the list of properties for this object.

RealAtMaximumAmplitude

Gets the RealAtMaximumAmplitude.

RemotePointSelection

Gets or sets the RemotePointSelection.

ReportedFrequency

Gets the ReportedFrequency.

RequestedFrequency

Gets or sets the RequestedFrequency.

ResultChartType

Gets the ResultChartType.

RpmSetNumber

Gets or sets the RpmSetNumber.

SectorNumber

Gets or sets the SectorNumber.

ShearOrientation

Gets or sets the ShearOrientation.

SpatialResolution

Gets or sets the SpatialResolution.

Spring

Gets or sets the Spring.

State

State property.

StressStrainType

Gets or sets the StressStrainType.

Suppressed

Gets or sets the Suppressed.

TabularData

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

TimeHistoryDisplay

Gets or sets the TimeHistoryDisplay.

UseParentFrequencyRange

Gets or sets the UseParentFrequencyRange.

VelocityType

Gets or sets the VelocityType.

VisibleProperties

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

XAxisValues

Gets or sets the XAxisValues.

Property detail#

property StressFrequencyResponse.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the AccelerationType.

property StressFrequencyResponse.BoundaryCondition: Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition | None#

Gets or sets the BoundaryCondition.

property StressFrequencyResponse.ChartDimensions: Ansys.Mechanical.DataModel.Enums.ChartDimensions | None#

Gets or sets the Chart Dimensions

property StressFrequencyResponse.ChartViewingStyle: Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None#

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

property StressFrequencyResponse.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystem. Accepts/Returns None if it is the Solution Coordinate System.

property StressFrequencyResponse.CurvesAppearanceDisplay: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None#

Gets or sets the CurvesAppearanceDisplay.

property StressFrequencyResponse.CutFrequency: float | None#

Gets or sets the CutFrequency.

property StressFrequencyResponse.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property StressFrequencyResponse.DeformationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the DeformationType.

property StressFrequencyResponse.DisplayOrder: bool | None#

Gets or sets the DisplayOrder.

property StressFrequencyResponse.DisplayPanel: bool | None#

Gets or sets the DisplayPanel.

property StressFrequencyResponse.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property StressFrequencyResponse.Duration: Ansys.Core.Units.Quantity | None#

Gets or sets the Duration.

property StressFrequencyResponse.EnhancedTracking: bool | None#

Gets the EnhancedTracking.

property StressFrequencyResponse.FilterMaximum: Ansys.Core.Units.Quantity | None#

Gets the FilterMaximum.

property StressFrequencyResponse.FilterMinimum: Ansys.Core.Units.Quantity | None#

Gets the FilterMinimum.

property StressFrequencyResponse.FilterType: Ansys.Mechanical.DataModel.Enums.FilterType | None#

Gets or sets the FilterType.

property StressFrequencyResponse.FrequencyAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the FrequencyAtMaximumAmplitude.

property StressFrequencyResponse.FrequencySelection: str | None#

Gets or sets the FrequencySelection.

property StressFrequencyResponse.GeometrySelectionString: str | None#

Gets or sets the GeometrySelectionString.

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

GroupingFolder property.

property StressFrequencyResponse.IconName: str | None#

IconName property.

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

Gets the list of associated images.

property StressFrequencyResponse.ImaginaryAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the ImaginaryAtMaximumAmplitude.

property StressFrequencyResponse.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None#

Gets the internal object. For advanced usage only.

property StressFrequencyResponse.IsSolved: bool | None#

Gets the IsSolved.

property StressFrequencyResponse.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property StressFrequencyResponse.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property StressFrequencyResponse.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property StressFrequencyResponse.MaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the MaximumAmplitude.

property StressFrequencyResponse.MaximumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MaximumFrequency.

property StressFrequencyResponse.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property StressFrequencyResponse.MinimumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MinimumFrequency.

property StressFrequencyResponse.Name: str | None#

Name property.

property StressFrequencyResponse.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None#

Gets or sets the NormalOrientation.

property StressFrequencyResponse.ObjectId: int | None#

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property StressFrequencyResponse.OrderSelection: str | None#

Gets or sets the OrderSelection.

property StressFrequencyResponse.OrdersToDisplay: int | None#

Gets or sets the OrdersToDisplay.

property StressFrequencyResponse.PanelContribution: bool | None#

Gets or sets the PanelContribution.

property StressFrequencyResponse.PanelsToDisplay: int | None#

Gets or sets the PanelsToDisplay.

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

Parent property.

property StressFrequencyResponse.PhaseAngle: Ansys.Core.Units.Quantity | None#

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property StressFrequencyResponse.RealAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the RealAtMaximumAmplitude.

property StressFrequencyResponse.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property StressFrequencyResponse.ReportedFrequency: Ansys.Core.Units.Quantity | None#

Gets the ReportedFrequency.

property StressFrequencyResponse.RequestedFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the RequestedFrequency.

property StressFrequencyResponse.ResultChartType: Ansys.Mechanical.DataModel.Enums.ChartResultType | None#

Gets the ResultChartType.

property StressFrequencyResponse.RpmSetNumber: int | None#

Gets or sets the RpmSetNumber.

property StressFrequencyResponse.SectorNumber: int | None#

Gets or sets the SectorNumber.

property StressFrequencyResponse.ShearOrientation: Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None#

Gets or sets the ShearOrientation.

property StressFrequencyResponse.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None#

Gets or sets the SpatialResolution.

property StressFrequencyResponse.Spring: Ansys.ACT.Automation.Mechanical.Connections.Spring | None#

Gets or sets the Spring.

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

State property.

property StressFrequencyResponse.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None#

Gets or sets the StressStrainType.

property StressFrequencyResponse.Suppressed: bool | None#

Gets or sets the Suppressed.

property StressFrequencyResponse.TabularData: Ansys.Mechanical.Interfaces.ITable | None#

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

property StressFrequencyResponse.TimeHistoryDisplay: Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None#

Gets or sets the TimeHistoryDisplay.

property StressFrequencyResponse.UseParentFrequencyRange: bool | None#

Gets or sets the UseParentFrequencyRange.

property StressFrequencyResponse.VelocityType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the VelocityType.

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

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

property StressFrequencyResponse.XAxisValues: Ansys.Mechanical.DataModel.Enums.XAxisValues | None#

Gets or sets the XAxisValues.

Method detail#

StressFrequencyResponse.Activate() None#

Activate the current object.

StressFrequencyResponse.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

StressFrequencyResponse.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.
StressFrequencyResponse.ClearGeneratedData() None#

Run the ClearGeneratedData action.

StressFrequencyResponse.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

StressFrequencyResponse.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

StressFrequencyResponse.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

StressFrequencyResponse.Delete() None#

Run the Delete action.

StressFrequencyResponse.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

StressFrequencyResponse.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

StressFrequencyResponse.EvaluateAllResults() None#

Run the EvaluateAllResults action.

StressFrequencyResponse.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#

Run the ExportAnimation action.

StressFrequencyResponse.GetAPIName(dispId: int) str#

Property name bound to dispId.

StressFrequencyResponse.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

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

Gets the list of children, filtered by type.

StressFrequencyResponse.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

StressFrequencyResponse.GetHashCode() int#

GetHashCode method.

StressFrequencyResponse.GetIconFile() System.Byte#

GetIconFile method.

StressFrequencyResponse.GetLifetimeService() Any#

GetLifetimeService method.

StressFrequencyResponse.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

StressFrequencyResponse.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

StressFrequencyResponse.GetPath() str#

GetPath method.

StressFrequencyResponse.GetPropertyName(dispId: int) str#

GetPropertyName method.

StressFrequencyResponse.GetPropertyValue(name: str) Any#

GetPropertyValue method.

StressFrequencyResponse.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto) str#

GetQuantityName method.

StressFrequencyResponse.GetQuantityNameFromType(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto) str#

GetQuantityNameFromType method.

StressFrequencyResponse.GetType() type#

GetType method.

StressFrequencyResponse.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

StressFrequencyResponse.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

StressFrequencyResponse.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

StressFrequencyResponse.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

StressFrequencyResponse.InitializeLifetimeService() Any#

InitializeLifetimeService method.

StressFrequencyResponse.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

StressFrequencyResponse.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

StressFrequencyResponse.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.
StressFrequencyResponse.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

StressFrequencyResponse.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

StressFrequencyResponse.RemoveParameter(propName: str) None#

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

StressFrequencyResponse.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

StressFrequencyResponse.ToString() str#

ToString method.