ImpedanceFrequencyResponse#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.ImpedanceFrequencyResponse#

Bases: object

Defines a ImpedanceFrequencyResponse.

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.

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.

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.

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.

NormalOrientation

Gets or sets the NormalOrientation.

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.

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 ImpedanceFrequencyResponse.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

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

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

Gets or sets the CurvesAppearanceDisplay.

property ImpedanceFrequencyResponse.CutFrequency: float | None#

Gets or sets the CutFrequency.

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

Gets the current DataModelObject's category.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property ImpedanceFrequencyResponse.EnhancedTracking: bool | None#

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property ImpedanceFrequencyResponse.GeometrySelectionString: str | None#

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property ImpedanceFrequencyResponse.IsSolved: bool | None#

Gets the IsSolved.

property ImpedanceFrequencyResponse.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

property ImpedanceFrequencyResponse.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

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

Gets or sets the NormalOrientation.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

Gets the RealAtMaximumAmplitude.

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

Gets or sets the RemotePointSelection.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property ImpedanceFrequencyResponse.SectorNumber: int | None#

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property ImpedanceFrequencyResponse.Suppressed: bool | None#

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property ImpedanceFrequencyResponse.UseParentFrequencyRange: bool | None#

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

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

Gets or sets the XAxisValues.

Method detail#

ImpedanceFrequencyResponse.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

ImpedanceFrequencyResponse.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ImpedanceFrequencyResponse.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

ImpedanceFrequencyResponse.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ImpedanceFrequencyResponse.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.
ImpedanceFrequencyResponse.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

ImpedanceFrequencyResponse.RemoveParameter(propName: str) None#

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

ImpedanceFrequencyResponse.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.