Class MBDAnalysisOptions

Inheritance
System.Object
APIBase
MBDAnalysisOptions
Implements
System.IEquatable<APIBase>
Inherited Members
Namespace: SMT.MastaAPI.SystemModel.AnalysesAndResults.MBDAnalyses
Assembly: SMT.MastaAPI.15.0.1.dll
Syntax
public sealed class MBDAnalysisOptions : APIBase, IEquatable<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>

ReportNames

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

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>

SplineDampingOptions

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

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

StaticLoadCaseUsedToSetInitialSpeeds

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

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

UseStaticLoadCaseToSetInitialSpeeds

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

UseTemperatureModel

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

Methods

AddLoggingVariable(DesignEntity, IReadOnlyList<String>, Boolean)

Declaration
public AnalysisCaseVariable AddLoggingVariable(DesignEntity designEntity, IReadOnlyList<string> path, bool applyToAllEntitiesOfSameType)
Parameters
Type Name Description
DesignEntity designEntity
System.Collections.Generic.IReadOnlyList<System.String> path
System.Boolean applyToAllEntitiesOfSameType
Returns
Type Description
AnalysisCaseVariable

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

RemoveLoggingVariable(AnalysisCaseVariable)

Declaration
public void RemoveLoggingVariable(AnalysisCaseVariable loggingVariable)
Parameters
Type Name Description
AnalysisCaseVariable loggingVariable

Implements

System.IEquatable<T>

Extension Methods