FrequencyResponseResultChart

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

Bases: object

Defines a FrequencyResponseResultChart.

Overview

Methods

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

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

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

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

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

Gets or sets the CurvesAppearanceDisplay.

property FrequencyResponseResultChart.CutFrequency: float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject's category.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property FrequencyResponseResultChart.EnhancedTracking: bool | None

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property FrequencyResponseResultChart.GeometrySelectionString: str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property FrequencyResponseResultChart.IsSolved: bool | None

Gets the IsSolved.

property FrequencyResponseResultChart.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

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

Gets or sets the NormalOrientation.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

Gets the RealAtMaximumAmplitude.

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

Gets or sets the RemotePointSelection.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property FrequencyResponseResultChart.SectorNumber: int | None

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property FrequencyResponseResultChart.Suppressed: bool | None

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property FrequencyResponseResultChart.UseParentFrequencyRange: bool | None

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

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

Gets or sets the XAxisValues.

Method detail

FrequencyResponseResultChart.Activate() → None

Activate the current object.

FrequencyResponseResultChart.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

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

FrequencyResponseResultChart.ClearGeneratedData() → None

Run the ClearGeneratedData action.

FrequencyResponseResultChart.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

FrequencyResponseResultChart.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

FrequencyResponseResultChart.Delete() → None

Run the Delete action.

FrequencyResponseResultChart.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

FrequencyResponseResultChart.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

FrequencyResponseResultChart.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

FrequencyResponseResultChart.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

FrequencyResponseResultChart.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

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

FrequencyResponseResultChart.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

FrequencyResponseResultChart.RemoveParameter(propName: str) → None

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

FrequencyResponseResultChart.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.