Class HarmonicAnalysisOptions

Inheritance
System.Object
APIBase
HarmonicAnalysisOptions
HarmonicAnalysisOptionsForAdvancedTimeSteppingAnalysisForModulation
Implements
System.IEquatable<APIBase>
Inherited Members
Namespace: SMT.MastaAPI.SystemModel.AnalysesAndResults.HarmonicAnalyses
Assembly: SMT.MastaAPI.15.0.dll
Syntax
public class HarmonicAnalysisOptions : APIBase, IEquatable<APIBase>

Properties

AcousticAnalysisSetup

Declaration
public ListWithSelectedItem<AcousticAnalysisSetup> AcousticAnalysisSetup { get; set; }
Property Value
Type Description
ListWithSelectedItem<AcousticAnalysisSetup>

AmplitudeCutOffForLinearTE

If the amplitude of a harmonic of the relative displacement in at the mesh in the line of action normal to the flanks is below this value MASTA will not calculate the response for that harmonic. For Cylindrical gears the relative displacement normal to the flanks is TE*Cos(Base Helix Angle).

Measurement: VeryShortLength

Declaration
public double AmplitudeCutOffForLinearTE { get; set; }
Property Value
Type Description
System.Double

AmplitudeCutOffForMisalignmentExcitation

If the amplitude of a harmonic of the misalignment excitation is below this value MASTA will not calculate the response for that harmonic.

Measurement: VerySmallAngle

Declaration
public double AmplitudeCutOffForMisalignmentExcitation { get; set; }
Property Value
Type Description
System.Double

CalculateUncoupledModesDuringAnalysis

Declaration
public virtual bool CalculateUncoupledModesDuringAnalysis { get; set; }
Property Value
Type Description
System.Boolean

ConstantModalDamping

Before additional damping ratios from strain energies are added, the modal damping factor is g + alpha/(2omega) + betaomega/2, where g is Constant Modal Damping, alpha is Rayleigh Damping Alpha, beta is Rayleigh Damping Beta, and omega is the frequency of the mode in rad/s. A total modal damping factor of 0 corresponds to no damping, while a value of 1 means critical damping.

Declaration
public double ConstantModalDamping { get; set; }
Property Value
Type Description
System.Double

CropToSpeedRangeForExportAndReports

Declaration
public virtual bool CropToSpeedRangeForExportAndReports { get; set; }
Property Value
Type Description
System.Boolean

DampingSpecification

Declaration
public EnumWithSelectedValue<DampingSpecification> DampingSpecification { get; set; }
Property Value
Type Description
EnumWithSelectedValue<DampingSpecification>

ExcitationSelection

Declaration
public ExcitationSourceSelectionGroup ExcitationSelection { get; }
Property Value
Type Description
ExcitationSourceSelectionGroup

FrequencyOptions

Used for RUNNA and Parametric Study Tool results.

Declaration
public FrequencyOptionsForHarmonicAnalysisResults FrequencyOptions { get; }
Property Value
Type Description
FrequencyOptionsForHarmonicAnalysisResults

ModalAnalysisOptions

Declaration
public ModalAnalysisOptions ModalAnalysisOptions { get; }
Property Value
Type Description
ModalAnalysisOptions

ModalCorrectionMethod

Modal computation can be expensive and often only lower frequency modes are calculated. This setting allows for correction to account for the lost higher frequency modes.

Declaration
public EnumWithSelectedValue<ModalCorrectionMethod> ModalCorrectionMethod { get; set; }
Property Value
Type Description
EnumWithSelectedValue<ModalCorrectionMethod>

NumberOfHarmonics

Declaration
public Overridable<int> NumberOfHarmonics { get; set; }
Property Value
Type Description
Overridable<System.Int32>

PerFrequencyDampingProfile

Allows input of modal damping factors as a function of frequency. A total modal damping factor of 0 corresponds to no damping, while a value of 1 means critical damping.

Declaration
public Vector2DListAccessor PerFrequencyDampingProfile { get; set; }
Property Value
Type Description
Vector2DListAccessor

PerModeDampingFactors

Declaration
public ReadOnlyCollection<double> PerModeDampingFactors { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<System.Double>

RayleighDampingAlpha

Before additional damping ratios from strain energies are added, the modal damping factor is g + alpha/(2omega) + betaomega/2, where g is Constant Modal Damping, alpha is Rayleigh Damping Alpha, beta is Rayleigh Damping Beta, and omega is the frequency of the mode in rad/s. A total modal damping factor of 0 corresponds to no damping, while a value of 1 means critical damping.

Measurement: InverseShortTime

Declaration
public double RayleighDampingAlpha { get; set; }
Property Value
Type Description
System.Double

RayleighDampingBeta

Before additional damping ratios from strain energies are added, the modal damping factor is g + alpha/(2omega) + betaomega/2, where g is Constant Modal Damping, alpha is Rayleigh Damping Alpha, beta is Rayleigh Damping Beta, and omega is the frequency of the mode in rad/s. A total modal damping factor of 0 corresponds to no damping, while a value of 1 means critical damping.

Measurement: TimeShort

Declaration
public double RayleighDampingBeta { get; set; }
Property Value
Type Description
System.Double

ReferenceSpeedOptions

Declaration
public SpeedOptionsForHarmonicAnalysisResults ReferenceSpeedOptions { get; }
Property Value
Type Description
SpeedOptionsForHarmonicAnalysisResults

ReportNames

Declaration
public IReadOnlyList<string> ReportNames { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>

ResponseCacheLevel

For large models the memory usage can be high. This setting allows the memory usage to be reduced at the expense of calculation time.

Declaration
public ResponseCacheLevel ResponseCacheLevel { get; set; }
Property Value
Type Description
ResponseCacheLevel

StiffnessOptions

Declaration
public StiffnessOptionsForHarmonicAnalysis StiffnessOptions { get; }
Property Value
Type Description
StiffnessOptionsForHarmonicAnalysis

TransferPathAnalysisSetupOptions

Declaration
public TransferPathAnalysisSetupOptions TransferPathAnalysisSetupOptions { get; }
Property Value
Type Description
TransferPathAnalysisSetupOptions

UpdateDynamicResponseChartOnChangeOfSettings

Controls whether the Dynamic Response Chart is updated automatically when settings are changed or requires the user to press a button to update it.

Declaration
public bool UpdateDynamicResponseChartOnChangeOfSettings { get; set; }
Property Value
Type Description
System.Boolean

UseLinearExtrapolation

Use linear extrapolation for mode frequencies outside of the defined profile range. Otherwise, a flat extrapolation is used. This option cannot be selected if the Per Frequency Damping Profile has fewer than two points.

Declaration
public bool UseLinearExtrapolation { get; set; }
Property Value
Type Description
System.Boolean

Methods

GetActiveReportWithEncodedImages()

Declaration
public string GetActiveReportWithEncodedImages()
Returns
Type Description
System.String

GetDefaultReportWithEncodedImages()

Declaration
public string GetDefaultReportWithEncodedImages()
Returns
Type Description
System.String

GetNamedReportWithEncodedImages(String)

Declaration
public string GetNamedReportWithEncodedImages(string reportName)
Parameters
Type Name Description
System.String reportName
Returns
Type Description
System.String

OutputActiveReportAsTextTo(String)

Declaration
public void OutputActiveReportAsTextTo(string filePath)
Parameters
Type Name Description
System.String filePath

OutputActiveReportTo(String)

Declaration
public void OutputActiveReportTo(string filePath)
Parameters
Type Name Description
System.String filePath

OutputDefaultReportTo(String)

Declaration
public void OutputDefaultReportTo(string filePath)
Parameters
Type Name Description
System.String filePath

OutputNamedReportAsMastaReport(String, String)

Declaration
public void OutputNamedReportAsMastaReport(string reportName, string filePath)
Parameters
Type Name Description
System.String reportName
System.String filePath

OutputNamedReportAsTextTo(String, String)

Declaration
public void OutputNamedReportAsTextTo(string reportName, string filePath)
Parameters
Type Name Description
System.String reportName
System.String filePath

OutputNamedReportTo(String, String)

Declaration
public void OutputNamedReportTo(string reportName, string filePath)
Parameters
Type Name Description
System.String reportName
System.String filePath

SetPerModeDampingFactor(Int32, Double)

Declaration
public void SetPerModeDampingFactor(int mode, double damping)
Parameters
Type Name Description
System.Int32 mode
System.Double damping

SetPerModeDampingFactors(List<Double>)

Declaration
public void SetPerModeDampingFactors(List<double> dampingValues)
Parameters
Type Name Description
System.Collections.Generic.List<System.Double> dampingValues

Implements

System.IEquatable<T>

Extension Methods