Class EigenvalueOptions

Inheritance
System.Object
APIBase
EigenvalueOptions
Implements
System.IEquatable<APIBase>
Inherited Members
Namespace: SMT.MastaAPI.NodalAnalysis.DevToolsAnalyses
Assembly: SMT.MastaAPI.15.0.dll
Syntax
public sealed class EigenvalueOptions : APIBase, IEquatable<APIBase>

Properties

CheckInternalModesFrequencyError

Selecting this option will give a status error if the Internal Modes Frequency Error is greater than the tolerance specified by Tolerance for Internal Modes Frequency Error. The Internal Modes Frequency Error is the largest relative error in the calculation of internal mode frequencies. If this quantity is large, it is likely that there is a problem with the FE reduction.

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

ForceIterativeOnlyAMLSSolve

Selecting this option sets the sub-level dense matrix size to 1 in the AMLS eigensolver, ensuring only an iterative solver is used. This prevents the use of a direct solver for smaller sub-level problems, which may improve accuracy of the internal mode frequency calculations, in some cases.

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

MaximumModeFrequency

Only modes that have a frequency less than or equal to this will be solved for.

Measurement: Frequency

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

MinimumModeFrequency

Only modes having frequencies greater than or equal to this will be solved for.

Measurement: Frequency

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

ModeFrequencyShift

The modes with a frequency closest to this value will be found.

Measurement: Frequency

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

ModeInputMethod

The method for selecting the modes to use.

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

NumberOfModes

The number of modes solved for if using the nearest to shift option or the maximum number of modes returned if using the lowest in range option.

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

OverallAMLSCutoffFactor

The frequencies at each substructure level are truncated at this factor times the upper frequency limit of the requested spectrum. This value will affect the accuracy of all modes. Recommended that this is no larger than 10. Must be greater than 1 and the reduced cutoff factor.

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

ReducedAMLSCutoffFactor

Higher values will tend to increase the accuracy of higher modes. Recommended that this is no larger than 2.5. Must be less than the overall cutoff factor and greater than 1.

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

ReportNames

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

ToleranceForInternalModesFrequencyError

An error will be given if the Internal Modes Frequency Error is greater than this tolerance. The Internal Modes Frequency Error is the largest relative error in the calculation of internal mode frequencies. If this quantity is large, it is likely that there is a problem with the FE reduction.

Measurement: Percentage

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

TypeOfEigenvalueSolver

The solver which is used to calculate vibration modes. The recommended value is set according to the number of nodes in the full FE model.

Declaration
public Overridable<ProSolveEigenmethod> TypeOfEigenvalueSolver { get; set; }
Property Value
Type Description
Overridable<ProSolveEigenmethod>

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

Implements

System.IEquatable<T>

Extension Methods