Skip to main content

Mechanical scripting interface

KrylovResidualNorm

Last update: 14.01.2025

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

Bases: object

Defines a KrylovResidualNorm.

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.
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.
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.
FrequencyAtMaximumResidual Gets the Frequency at which the Residual is maximum.
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.
MaximumResidual Gets the Maximum Residual value across the frequency range.
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.
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 KrylovResidualNorm.AccelerationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

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

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

Gets or sets the CurvesAppearanceDisplay.

property KrylovResidualNorm.CutFrequency : float | None

Gets or sets the CutFrequency.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property KrylovResidualNorm.EnhancedTracking : bool | None

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property KrylovResidualNorm.FrequencyAtMaximumResidual : Ansys.Core.Units.Quantity | None

Gets the Frequency at which the Residual is maximum.

property KrylovResidualNorm.GeometrySelectionString : str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property KrylovResidualNorm.IsSolved : bool | None

Gets the IsSolved.

property KrylovResidualNorm.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

property KrylovResidualNorm.MaximumResidual : float | None

Gets the Maximum Residual value across the frequency range.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

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

Gets or sets the NamedSelections.

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

Gets or sets the NormalOrientation.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

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

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

Gets the RealAtMaximumAmplitude.

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

Gets or sets the RemotePointSelection.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property KrylovResidualNorm.SectorNumber : int | None

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property KrylovResidualNorm.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property KrylovResidualNorm.UseParentFrequencyRange : bool | None

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

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

Gets or sets the XAxisValues.

Method detail

KrylovResidualNorm.Activate()

Activate the current object.

KrylovResidualNorm.AddComment()

Creates a new child Comment.

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

KrylovResidualNorm.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

KrylovResidualNorm.CreateParameter(propName: str)

Creates a new parameter for a Property.

KrylovResidualNorm.Delete()

Run the Delete action.

KrylovResidualNorm.Duplicate()

Creates a copy of the current DataModelObject.

KrylovResidualNorm.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

KrylovResidualNorm.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

KrylovResidualNorm.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

KrylovResidualNorm.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

KrylovResidualNorm.PropertyByName(name: str)

Get a property by its unique name.

KrylovResidualNorm.RemoveParameter(propName: str)

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

KrylovResidualNorm.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.