Class NonLinearDQModelGeneratorSettings
  
  
  
  
    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    
    NonLinearDQModelGeneratorSettings
   
  
  
    Inherited Members
    
    
    
    
    
    
    
    
    
    
    
    
      APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
     
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    
   
  
  Assembly: SMT.MastaAPI.13.0.dll
  Syntax
  
    public class NonLinearDQModelGeneratorSettings : APIBase, IEquatable<APIBase>
   
  Fields
  
  
  
  _parent
  
  
  Declaration
  
    protected readonly APIBase _parent
   
  Field Value
  
  Properties
  
  
  
  
  AnalysisPeriod
  
  
  Declaration
  
    public EnumWithSelectedValue<ElectricMachineAnalysisPeriod> AnalysisPeriod { get; set; }
   
  Property Value
  
  
  
  
  CopyAllSetups
  
  
  Declaration
  
    public bool CopyAllSetups { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  ExponentForACWindingLossTemperatureScaling
  An exponent that can be experimentally derived. See e.g. Wrobel, R., Salt, D.E., Griffo, A., Simpson, N. and Mellor, P.H., 2013. Derivation and scaling of AC copper loss in thermal modelling of electrical machines. IEEE Transactions on Industrial Electronics, 61(8), pp.4412-4420.
Declaration
  
    public double ExponentForACWindingLossTemperatureScaling { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  IncludeACWindingLosses
  If AC Winding Losses are included a transient analysis will be run.
Declaration
  
    public bool IncludeACWindingLosses { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  IncludeEfficiency
  
  
  Declaration
  
    public bool IncludeEfficiency { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
  
  
  
  
  
  Declaration
  
    public double MaximumCurrentAngleForMap { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  
  Measurement: ElectricCurrent
Declaration
  
    public Overridable<double> MaximumPeakLineCurrentMagnitudeForMap { get; set; }
   
  Property Value
  
  
  
  
  
  
  
  Declaration
  
    public double MinimumCurrentAngleForMap { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  
  Measurement: ElectricCurrent
Declaration
  
    public double MinimumPeakLineCurrentMagnitudeForMap { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  NonLinearSystemConvergenceTolerance
  The default value should be sufficient for most cases. However, this option can be used if users would like to adjust the convergence criteria.
Declaration
  
    public double NonLinearSystemConvergenceTolerance { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
  
  
  NumberOfCurrentAnglePoints
  
  
  Declaration
  
    public int NumberOfCurrentAnglePoints { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  
  NumberOfCurrentMagnitudePoints
  
  
  Declaration
  
    public int NumberOfCurrentMagnitudePoints { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  
  NumberOfInitialTransientSteps
  
  
  Declaration
  
    public int NumberOfInitialTransientSteps { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  
  NumberOfTimeStepsForAnalysisPeriod
  
  
  Declaration
  
    public int NumberOfTimeStepsForAnalysisPeriod { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
  
  
  ReferenceSpeed
  Measurement: AngularVelocity
Declaration
  
    public double ReferenceSpeed { 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> |  | 
    
  
  
  
  
  Temperatures
  
  
  Declaration
  
    public Temperatures Temperatures { get; }
   
  Property Value
  
  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