Version: 13.0

    Show / Hide Table of Contents

    Class MBDAnalysisOptions

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    MBDAnalysisOptions
    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.MBDAnalyses
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class MBDAnalysisOptions : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    AnalysisType

    Specify either a normal analysis or various options for setting up more specialised analysis types.

    Declaration
    public AnalysisTypes AnalysisType { get; set; }
    Property Value
    Type Description
    AnalysisTypes

    BearingRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters. Typical values for bearings are in the range 1e-6 to 1e-4.

    Measurement: TimeShort

    Declaration
    public Overridable<double> BearingRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    BearingStiffnessModel

    Concept bearings use 1e9 N/m for the linear stiffness and 1e6 Nm/Rad for the tilt stiffness for any non-linear bearings in the model. The system deflection results will only be accurate if the bearing loads do not change much from the load case. The non-linear bearing model is the most accurate but slow to calculate.

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

    BeltRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters.

    Measurement: TimeShort

    Declaration
    public Overridable<double> BeltRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    CreateInertiaAdjustedStaticLoadCases

    Allow the creation of equivalent static load cases from the dynamic results at particular time points.

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

    ExternalInterfaceOptions

    Declaration
    public DynamicExternalInterfaceOptions ExternalInterfaceOptions { get; }
    Property Value
    Type Description
    DynamicExternalInterfaceOptions

    FilterCutOff

    The cutoff frequency for the low pass filter used in Time response display. It is also used by the run-up chart if the processing option is set to 'Filter'.

    Measurement: Frequency

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

    FrequencyResponseOptions

    Declaration
    public FrequencyResponseAnalysisOptions FrequencyResponseOptions { get; }
    Property Value
    Type Description
    FrequencyResponseAnalysisOptions

    GearMeshRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters. Typical values for gear meshes are in the range 1e-6 to 1e-4.

    Measurement: TimeShort

    Declaration
    public Overridable<double> GearMeshRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    GearMeshStiffnessModel

    Simple stiffness uses the ISO mesh stiffness or specified mesh stiffness for cylindrical gears. Basic LTCA uses a strip model where the potential contact lines are calculated from the macro geometry and then divided into strips. Each strip is given a proportion of the stiffness according to the ISO 6336 Single Stiffness value. Micro geometry is included via a modification of the gaps for each contact point pair.

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

    IncludeGearBacklash

    Select this to include gear backlash in the analysis and so allow loss of contact. Without backlash the gear meshes will always be in contact on one or both flanks.

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

    IncludeMicrogeometry

    Select this to include microgeometry in the analysis to obtain a detailed load distribution. This option is not available when any of the gears have a separate micro geometry specified for each of its teeth.

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

    IncludeShaftAndHousingFlexibilities

    Set to 'Full Flexibilities' to include shaft and housing flexibilities in the analysis for all six degrees of freedom. If set to 'None (Rigid Body)' then shafts and ungrounded housings are treated as torsional only rigid bodies and grounded housings will not be included in the analysis.

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

    InterferenceFitRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters.

    Measurement: TimeShort

    Declaration
    public Overridable<double> InterferenceFitRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    LoadCaseForComponentSpeedRatios

    Declaration
    public ListWithSelectedItem<string> LoadCaseForComponentSpeedRatios { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    LoadCaseForLinearisedBearingStiffness

    Declaration
    public ListWithSelectedItem<string> LoadCaseForLinearisedBearingStiffness { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    MaximumAngularJerk

    Results for the angular jerk are clipped to this value when calculated.

    Measurement: AngularJerk

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

    MaximumFrequencyInSignal

    Maximum Frequency present in the signal. This is used to determine the sampling frequency used in the most of the signal processing.

    Measurement: Frequency

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

    MethodToDefinePeriod

    Use 'Time Period' to specify the length of the sample or 'Power Load Angle' to use the rotation of a power load to define the sample period.

    Declaration
    public InertiaAdjustedLoadCasePeriodMethod MethodToDefinePeriod { get; set; }
    Property Value
    Type Description
    InertiaAdjustedLoadCasePeriodMethod

    NumberOfStaticLoadCases

    Load cases will be equally distributed between the start and end times of the sample including one at each end.

    Declaration
    public int NumberOfStaticLoadCases { get; set; }
    Property Value
    Type Description
    System.Int32

    PowerLoadRotation

    The sample period used to create the static load cases starts at the specified start time and finishes when the reference power load has rotated by this amount in either direction.

    Measurement: Angle

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

    ReferencePowerLoadToDefinePeriod

    The power load used to measure the angular change from the start time.

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

    RunUpAnalysisOptions

    Declaration
    public MBDRunUpAnalysisOptions RunUpAnalysisOptions { get; }
    Property Value
    Type Description
    MBDRunUpAnalysisOptions

    SampleLength

    Length of the sample used to create the static load cases. The final load case will be at the start time plus the sample length.

    Measurement: TimeShort

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

    ShaftAndHousingRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters. Typical values for shafts and housings are in the range 1e-7 to 1e-5.

    Measurement: TimeShort

    Declaration
    public Overridable<double> ShaftAndHousingRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    SplineRayleighDampingBeta

    The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters.

    Measurement: TimeShort

    Declaration
    public Overridable<double> SplineRayleighDampingBeta { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    StartAtZeroAngle

    If this option is selected, the period will begin at the next zero in the reference angle after the start time. Otherwise, the period will begin at the start time.

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

    StartTime

    Time at which the first static load case will be created.

    Measurement: TimeShort

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

    StaticLoadCasesToCreate

    'Load Cases Over Time' creates the specified number of static load cases between the start and end of the defined period. 'Peak Loads For Gears' creates load cases for each gear. These represent the worst possible scenario where one tooth always sees the peak load. For a gear with multiple meshes it is assumed that the same tooth sees the peak load on every mesh, which is conservative.

    Declaration
    public InertiaAdjustedLoadCaseResultsToCreate StaticLoadCasesToCreate { get; set; }
    Property Value
    Type Description
    InertiaAdjustedLoadCaseResultsToCreate

    TransientSolverOptions

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

    UseLoadSensitiveStiffness

    If this option is selected, the load sensitive stiffness value from ISO 6336-1:2006 is used rather than the basic single tooth stiffness. The difference is largest for low loads.

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

    UseTemperatureModel

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

    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