Version: 13.0

    Show / Hide Table of Contents

    Class HarmonicAnalysisOptions

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    HarmonicAnalysisOptions
    HarmonicAnalysisOptionsForAdvancedTimeSteppingAnalysisForModulation
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.SystemModel.AnalysesAndResults.HarmonicAnalyses
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class HarmonicAnalysisOptions : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    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

    CropToSpeedRangeForExportAndReports

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

    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

    ModalDampingFactor

    Determines the modal damping factor used in the analysis, 0 = No Damping, 1 = Critical Damping

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

    NumberOfHarmonics

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

    PenaltyMassForEnforcedTE

    Measurement: Mass

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

    PenaltyStiffnessForEnforcedTE

    Measurement: Mass

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

    PerModeDampingFactors

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

    RayleighDampingAlpha

    The total modal damping factor is g + alpha/(2omega) + betaomega/2, where g is Modal Damping Factor, alpha is Rayleigh Damping Alpha, beta is Rayleigh Damping Beta and omega is the frequency of the mode in rad/s.

    Measurement: InverseShortTime

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

    RayleighDampingBeta

    The total modal damping factor is g + alpha/(2omega) + betaomega/2, where g is Modal Damping Factor, alpha is Rayleigh Damping Alpha, beta is Rayleigh Damping Beta and omega is the frequency of the mode in rad/s.

    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

    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

    SpecifyPerModeDampingFactors

    Allows input of modal damping factors on a per mode basis

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

    StiffnessOptions

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

    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

    Methods

    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

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    Back to top