Class ThermalNetworkSolverSettings

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

Properties

AbsoluteTolerancePressure

The values are treated as not changing if the absolute change in the pressure is less than this value.

Measurement: PressureSmall

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

AbsoluteToleranceTemperature

The values are treated as not changing if the absolute change in the temperature is less than this value.

Measurement: Temperature

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

AbsoluteToleranceVolumetricFlowRate

The values are treated as not changing if the absolute change in the volumetric flow rate is less than this value.

Measurement: FlowRate

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

MaximumNumberOfIterations

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

PowerAbsoluteTolerance

Measurement: PowerSmall

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

PowerRelativeTolerance

Measurement: Percentage

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

PressureAbsoluteTolerance

Measurement: PressureSmall

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

PressureRelativeTolerance

Measurement: Percentage

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

RelativeTolerance

The values are treated as not changing if the relative change is less than this value.

Measurement: Percentage

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

Relaxation

Declaration
public double Relaxation { 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>

ResidualPressureAndVolumetricFlowRateTolerance

The maximum pressure residual allowed for convergence.

Measurement: PressureSmall

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

ResidualRelativeTolerance

For each entry in the residual the maximum error is calculated from the sum of the absolute forces on the degree of freedom multiplied by this tolerance.

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

ResidualTemperatureTolerance

The maximum temperature residual allowed for convergence.

Measurement: PowerSmall

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

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