Class SystemOptimiserDetails

Inheritance
System.Object
APIBase
SystemOptimiserDetails
Implements
System.IEquatable<APIBase>
Inherited Members
Namespace: SMT.MastaAPI.SystemModel.Optimization.SystemOptimiser
Assembly: SMT.MastaAPI.15.0.dll
Syntax
public sealed class SystemOptimiserDetails : APIBase, IEquatable<APIBase>

Properties

AvoidSpecificOrders

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

CheckFrequencySeparation

Reject tooth numbers that have gear mesh frequencies closer to each other than the specified limit.

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

CheckPassingOrderSeparation

Reject tooth numbers that have gear mesh passing orders closer to each other than the specified limit.

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

CriteriaForSelectingConfigurationsToKeep

Declaration
public SystemOptimiserTargets CriteriaForSelectingConfigurationsToKeep { get; set; }
Property Value
Type Description
SystemOptimiserTargets

FilterDesignsOnEstimatedMaximumAchievableTransverseContactRatio

If fewer candidates than expected are found, turning off this filter helps understand if the problem is the required minimum transverse contact ratio.

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

GearSetOptimisation

Declaration
public SystemOptimiserGearSetOptimisation GearSetOptimisation { get; set; }
Property Value
Type Description
SystemOptimiserGearSetOptimisation

InputShaftSpeedForGearMeshFrequencySeparationTest

The calculated value is the speed of the input power load in the first load case of the first design state

Measurement: AngularVelocity

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

MaximumNumberOfConfigurationsToCreate

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

MaximumNumberOfSolutions

Keep searching until the number of solutions is smaller than this value

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

MinimumNumberOfSolutions

The minimum number of solutions to be found

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

ModifyFaceWidths

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

NumberOfHarmonicsForFrequencySeparationTest

The number of harmonics to consider when checking the frequency gap between two gear meshes

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

NumberOfHarmonicsForPassingOrderSeparationTest

The number of harmonics to consider when checking the passing order between two gear meshes

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

NumberOfOrdersToAvoid

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

NumberOfSolutions

The total number of distinct system designs that satisfy the target ratios. If the design contains planetary gear sets then additional configurations will be created varying the number of planets.

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

PlanetGearOptions

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

ReportNames

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

RequiredGearMeshFrequencySeparation

Tooth numbers will only be considered if their gear mesh frequencies are at least this far apart from one another at the specified input speed

Measurement: Frequency

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

RequiredGearMeshFrequencySeparationPercentage

Tooth numbers will only be considered if their gear mesh frequencies are at least this percentage different from one another at the specified input speed

Measurement: Percentage

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

RequiredNormalisedSafetyFactor

Designs that fail to achieve this safety factor will be removed

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

RequiredPassingOrderSeparation

Tooth numbers will only be considered if their gear mesh passing orders are at least this far apart from one another

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

ShowRatioAsSpeedIncreasing

Declaration
public Overridable<bool> ShowRatioAsSpeedIncreasing { get; set; }
Property Value
Type Description
Overridable<System.Boolean>

TargetMaximumAbsoluteCylindricalGearProfileShiftCoefficient

Gear sets with more than two gears will use the profile shift coefficient to determine if clashes between unmeshed gears can be avoided. If this value is large it may result in undesirable geometry.

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

TargetRatios

Declaration
public ReadOnlyCollection<DesignStateTargetRatio> TargetRatios { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<DesignStateTargetRatio>

ToleranceForCombiningDutyCycles

The same tooth numbers may be used by a gear set in more than one solution, and if the loading is similar in multiple solutions then time can be saved by performing macro geometry optimisation only once and using the result for multiple solutions. This is the relative tolerance used for speed and torque to determine if two load cases are close enough to be considered the same.

Measurement: Percentage

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

Methods

CreateDesigns()

Can be used to have a look at the designs that System Optimiser will be starting with

Declaration
public void CreateDesigns()

DetermineRatioTolerances()

Set the tolerances on the Target Ratios required to find the Desired Number of Solutions

Declaration
public void DetermineRatioTolerances()

FindSolutionsFromCurrentRatioTolerances()

Find tooth numbers within the specified tooth number ranges that give the specified Target Ratios within the specified Target Ratio Tolerances

Declaration
public void FindSolutionsFromCurrentRatioTolerances()

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

PerformSystemOptimisation()

Search all tooth numbers within the limits set on each gear set to find combinations to achieve the correct ratio as specified by Target Ratio on the Design State. Uses macro geometry optimisation to find potential gear set designs, and selects the combination of gear set designs that gives best result for the current Target property.

Declaration
public void PerformSystemOptimisation()

Implements

System.IEquatable<T>

Extension Methods