Skip to main content

Mechanical scripting interface

CampbellDiagram

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ResultTrackers.CampbellDiagram

Bases: object

Defines a CampbellDiagram.

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.
CriticalSpeed Gets or sets the CriticalSpeed.
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.
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.
Ratio Gets or sets the Ratio.
RealAtMaximumAmplitude Gets the RealAtMaximumAmplitude.
ReportedFrequency Gets the ReportedFrequency.
RequestedFrequency Gets or sets the RequestedFrequency.
ResultChartType Gets the ResultChartType.
RotationalVelocitySelection Gets or sets the Rotational Velocity Selection Type.
SectorNumber Gets or sets the SectorNumber.
ShearOrientation Gets or sets the ShearOrientation.
Sorting Gets or sets the Sorting.
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.
XAxisLabel Gets or sets the XAxisLabel.
XAxisMaximum Gets or sets the XAxisMaximum.
XAxisMinimum Gets or sets the XAxisMinimum.
XAxisRange Gets or sets the XAxisRange.
XAxisValues Gets or sets the XAxisValues.
YAxisData Gets or sets the YAxisData.
YAxisLabel Gets or sets the YAxisLabel.
YAxisMaximum Gets or sets the YAxisMaximum.
YAxisMinimum Gets or sets the YAxisMinimum.
YAxisRange Gets or sets the YAxisRange.

Property detail

property CampbellDiagram.AccelerationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

property CampbellDiagram.CriticalSpeed : bool | None

Gets or sets the CriticalSpeed.

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

Gets or sets the CurvesAppearanceDisplay.

property CampbellDiagram.CutFrequency : float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property CampbellDiagram.EnhancedTracking : bool | None

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property CampbellDiagram.GeometrySelectionString : str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property CampbellDiagram.IsSolved : bool | None

Gets the IsSolved.

property CampbellDiagram.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

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

Gets or sets the NamedSelections.

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

Gets or sets the NormalOrientation.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

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

property CampbellDiagram.Ratio : float | None

Gets or sets the Ratio.

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

Gets the RealAtMaximumAmplitude.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property CampbellDiagram.RotationalVelocitySelection : Any | None

Gets or sets the Rotational Velocity Selection Type.

property CampbellDiagram.SectorNumber : int | None

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

property CampbellDiagram.Sorting : bool | None

Gets or sets the Sorting.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property CampbellDiagram.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property CampbellDiagram.UseParentFrequencyRange : bool | None

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

property CampbellDiagram.XAxisLabel : str | None

Gets or sets the XAxisLabel.

property CampbellDiagram.XAxisMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the XAxisMaximum.

property CampbellDiagram.XAxisMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the XAxisMinimum.

property CampbellDiagram.XAxisRange : Ansys.Mechanical.DataModel.Enums.DSCampbellAxisRange | None

Gets or sets the XAxisRange.

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

Gets or sets the XAxisValues.

property CampbellDiagram.YAxisData : Ansys.Mechanical.DataModel.Enums.DSCampbellYAxisDataType | None

Gets or sets the YAxisData.

property CampbellDiagram.YAxisLabel : str | None

Gets or sets the YAxisLabel.

property CampbellDiagram.YAxisMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the YAxisMaximum.

property CampbellDiagram.YAxisMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the YAxisMinimum.

property CampbellDiagram.YAxisRange : Ansys.Mechanical.DataModel.Enums.DSCampbellAxisRange | None

Gets or sets the YAxisRange.

Method detail

CampbellDiagram.Activate()

Activate the current object.

CampbellDiagram.AddComment()

Creates a new child Comment.

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

CampbellDiagram.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

CampbellDiagram.CreateParameter(propName: str)

Creates a new parameter for a Property.

CampbellDiagram.Delete()

Run the Delete action.

CampbellDiagram.Duplicate()

Creates a copy of the current DataModelObject.

CampbellDiagram.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

CampbellDiagram.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CampbellDiagram.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CampbellDiagram.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CampbellDiagram.PropertyByName(name: str)

Get a property by its unique name.

CampbellDiagram.RemoveParameter(propName: str)

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

CampbellDiagram.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.