Skip to main content

Mechanical scripting interface

ForceReactionFrequencyResponse

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.ForceReactionFrequencyResponse

Bases: object

Defines a ForceReactionFrequencyResponse.

Overview

Methods

Name Description
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.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
EvaluateAllResults Run the EvaluateAllResults action.
ExportAnimation Run the ExportAnimation action.
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.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
AccelerationType Gets or sets the AccelerationType.
Beam Gets or sets the Beam.
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.
ContactRegion Gets or sets the ContactRegion.
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.
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.
GeometrySelectionString Gets or sets the GeometrySelectionString.
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.
LocationMethod Gets or sets the LocationMethod.
Maximum Gets the Maximum.
MaximumAmplitude Gets the MaximumAmplitude.
MaximumFrequency Gets or sets the MaximumFrequency.
Minimum Gets the Minimum.
MinimumFrequency Gets or sets the MinimumFrequency.
NamedSelections Gets or sets the NamedSelections.
NormalOrientation Gets or sets the NormalOrientation.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
RealAtMaximumAmplitude Gets the RealAtMaximumAmplitude.
RemotePoint Gets or sets the RemotePoint.
RemotePointSelection Gets or sets the RemotePointSelection.
ReportedFrequency Gets the ReportedFrequency.
RequestedFrequency Gets or sets the RequestedFrequency.
ResultChartType Gets the ResultChartType.
SectorNumber Gets or sets the SectorNumber.
ShearOrientation Gets or sets the ShearOrientation.
SpatialResolution Gets or sets the SpatialResolution.
Spring Gets or sets the Spring.
StressStrainType Gets or sets the StressStrainType.
Suppressed Gets or sets the Suppressed.
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 ForceReactionFrequencyResponse.AccelerationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

property ForceReactionFrequencyResponse.Beam : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the Beam.

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

Gets or sets the BoundaryCondition.

property ForceReactionFrequencyResponse.ChartDimensions : Ansys.Mechanical.DataModel.Enums.ChartDimensions | None

Gets or sets the Chart Dimensions

property ForceReactionFrequencyResponse.ChartViewingStyle : Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

property ForceReactionFrequencyResponse.ContactRegion : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegion.

property ForceReactionFrequencyResponse.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

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

property ForceReactionFrequencyResponse.CurvesAppearanceDisplay : Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None

Gets or sets the CurvesAppearanceDisplay.

property ForceReactionFrequencyResponse.CutFrequency : float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject’s category.

property ForceReactionFrequencyResponse.DeformationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the DeformationType.

property ForceReactionFrequencyResponse.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

property ForceReactionFrequencyResponse.Duration : Ansys.Core.Units.Quantity | None

Gets or sets the Duration.

property ForceReactionFrequencyResponse.EnhancedTracking : bool | None

Gets the EnhancedTracking.

property ForceReactionFrequencyResponse.FilterMaximum : Ansys.Core.Units.Quantity | None

Gets the FilterMaximum.

property ForceReactionFrequencyResponse.FilterMinimum : Ansys.Core.Units.Quantity | None

Gets the FilterMinimum.

property ForceReactionFrequencyResponse.FilterType : Ansys.Mechanical.DataModel.Enums.FilterType | None

Gets or sets the FilterType.

property ForceReactionFrequencyResponse.FrequencyAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the FrequencyAtMaximumAmplitude.

property ForceReactionFrequencyResponse.GeometrySelectionString : str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

property ForceReactionFrequencyResponse.ImaginaryAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the ImaginaryAtMaximumAmplitude.

property ForceReactionFrequencyResponse.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None

Gets the internal object. For advanced usage only.

property ForceReactionFrequencyResponse.IsSolved : bool | None

Gets the IsSolved.

property ForceReactionFrequencyResponse.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

property ForceReactionFrequencyResponse.LocationMethod : Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property ForceReactionFrequencyResponse.Maximum : Ansys.Core.Units.Quantity | None

Gets the Maximum.

property ForceReactionFrequencyResponse.MaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the MaximumAmplitude.

property ForceReactionFrequencyResponse.MaximumFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the MaximumFrequency.

property ForceReactionFrequencyResponse.Minimum : Ansys.Core.Units.Quantity | None

Gets the Minimum.

property ForceReactionFrequencyResponse.MinimumFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the MinimumFrequency.

property ForceReactionFrequencyResponse.NamedSelections : Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets the NamedSelections.

property ForceReactionFrequencyResponse.NormalOrientation : Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None

Gets or sets the NormalOrientation.

property ForceReactionFrequencyResponse.PhaseAngle : Ansys.Core.Units.Quantity | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property ForceReactionFrequencyResponse.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property ForceReactionFrequencyResponse.RealAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the RealAtMaximumAmplitude.

property ForceReactionFrequencyResponse.RemotePoint : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePoint.

property ForceReactionFrequencyResponse.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property ForceReactionFrequencyResponse.ReportedFrequency : Ansys.Core.Units.Quantity | None

Gets the ReportedFrequency.

property ForceReactionFrequencyResponse.RequestedFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the RequestedFrequency.

property ForceReactionFrequencyResponse.ResultChartType : Ansys.Mechanical.DataModel.Enums.ChartResultType | None

Gets the ResultChartType.

property ForceReactionFrequencyResponse.SectorNumber : int | None

Gets or sets the SectorNumber.

property ForceReactionFrequencyResponse.ShearOrientation : Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None

Gets or sets the ShearOrientation.

property ForceReactionFrequencyResponse.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None

Gets or sets the SpatialResolution.

property ForceReactionFrequencyResponse.Spring : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the Spring.

property ForceReactionFrequencyResponse.StressStrainType : Ansys.Mechanical.DataModel.Enums.StressStrainType | None

Gets or sets the StressStrainType.

property ForceReactionFrequencyResponse.Suppressed : bool | None

Gets or sets the Suppressed.

property ForceReactionFrequencyResponse.TimeHistoryDisplay : Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None

Gets or sets the TimeHistoryDisplay.

property ForceReactionFrequencyResponse.UseParentFrequencyRange : bool | None

Gets or sets the UseParentFrequencyRange.

property ForceReactionFrequencyResponse.VelocityType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the VelocityType.

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

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

property ForceReactionFrequencyResponse.XAxisValues : Ansys.Mechanical.DataModel.Enums.XAxisValues | None

Gets or sets the XAxisValues.

Method detail

ForceReactionFrequencyResponse.Activate()

Activate the current object.

ForceReactionFrequencyResponse.AddComment()

Creates a new child Comment.

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

ForceReactionFrequencyResponse.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ForceReactionFrequencyResponse.CreateParameter(propName: str)

Creates a new parameter for a Property.

ForceReactionFrequencyResponse.Delete()

Run the Delete action.

ForceReactionFrequencyResponse.Duplicate()

Creates a copy of the current DataModelObject.

ForceReactionFrequencyResponse.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ForceReactionFrequencyResponse.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ForceReactionFrequencyResponse.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ForceReactionFrequencyResponse.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ForceReactionFrequencyResponse.PropertyByName(name: str)

Get a property by its unique name.

ForceReactionFrequencyResponse.RemoveParameter(propName: str)

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

ForceReactionFrequencyResponse.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.