Class AcousticAnalysisOptions
Inheritance
System.Object
AcousticAnalysisOptions
Assembly: SMT.MastaAPI.15.0.dll
Syntax
public sealed class AcousticAnalysisOptions : APIBase, IEquatable<APIBase>
Properties
ForceUnitVelocity
Selecting this setting will force a unit velocity on all elements except filled holes.
Declaration
public bool ForceUnitVelocity { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
FrequencyThresholdFactor
Changes the switching threshold between the low frequency and high frequency solvers. A higher value will create more low frequency cells.
Declaration
public Overridable<double> FrequencyThresholdFactor { get; set; }
Property Value
HighFrequencyMultiplier
Scale factor for the p-term at high frequencies. The p-term is the truncation constant used in the calculation of cell moments.
Declaration
public Overridable<int> HighFrequencyMultiplier { get; set; }
Property Value
InitialGuess
Choice of the initial guess used in the iterative solver for the surface pressure solution.
Declaration
public InitialGuessOption InitialGuess { get; set; }
Property Value
IntegrationOrder
The order of integration used for each surface element in standard integrals.
Declaration
public Overridable<int> IntegrationOrder { get; set; }
Property Value
IntegrationOrderMoments
The order of integration used for each surface element when calculating moments of standard integrals.
Declaration
public Overridable<int> IntegrationOrderMoments { get; set; }
Property Value
LowFrequencyMultiplier
Scale factor for the p-term at low frequencies. The p-term is the truncation constant used in the calculation of cell moments.
Declaration
public Overridable<int> LowFrequencyMultiplier { get; set; }
Property Value
M2LCacheType
Pre-calculate the M2L coefficients between each cell and its set of interactions. This reduces computation times for each iteration, at the cost of increased memory usage. It is recommended to use this option only after selecting the 'Adjacent Cells' cache type for the near field integrals.
Declaration
public M2LHfCacheType M2LCacheType { get; set; }
Property Value
MaximumLevel
In the creation of a fixed-level octree, this value determines the number of levels in the tree. For each level, elements are subdivided and distributed into 8 adjacent cells.
Declaration
public Overridable<int> MaximumLevel { get; set; }
Property Value
MaximumNumberOfElements
In an adaptive octree creation, this value determines the point at which we stop creating new cells; i.e., the maximum number of elements in the innermost cells. A value in the range 20 - 100 is recommended.
Declaration
public Overridable<int> MaximumNumberOfElements { get; set; }
Property Value
MaximumNumberOfIterations
The total number of iterations the solver will terminate at, regardless of the size of the solution residual.
Declaration
public Overridable<int> MaximumNumberOfIterations { get; set; }
Property Value
NearFieldIntegralsCacheType
Pre-calculate near field integrals for each frequency. This reduces computation times for each iteration, at the cost of increased memory usage.
Declaration
public NearFieldIntegralsCacheType NearFieldIntegralsCacheType { get; set; }
Property Value
OctreeCreationMethod
Method used to create the octree for the solver. The octree partitions the input surface into a structure of low or high frequency cells based on the value of Frequency Threshold Factor; a cell's type determines the type of solver used for it.
Declaration
public OctreeCreationMethod OctreeCreationMethod { get; set; }
Property Value
OptimiseMaximumNumberOfElements
In an adaptive octree creation, selecting this setting will optimise the maximum number of elements per cell based on existing calibrations with model size (number of total elements in the input surface).
Declaration
public bool OptimiseMaximumNumberOfElements { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
If this setting is selected, a log file will be created in the temp directory for each iterative solver run.
Declaration
public bool PerformIterativeSolverLogging { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Preconditioner
Using a preconditioner will increase convergence rate of the iterative solver. This reduces the total solution time, at the cost of increased memory usage.
Declaration
public AcousticPreconditionerType Preconditioner { get; set; }
Property Value
ReportNames
Declaration
public IReadOnlyList<string> ReportNames { get; }
Property Value
| Type |
Description |
| System.Collections.Generic.IReadOnlyList<System.String> |
|
ShowAdvancedSolverSettings
Show advanced settings relating to the octree creation; changing these may affect performance and convergence.
Declaration
public bool ShowAdvancedSolverSettings { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
SolverRelativeTolerance
Relative tolerance on the solution residuals when solving for the pressure at the boundary. This tolerance is used as the termination criterion for the iterative solver.
Measurement: Percentage
Declaration
public Overridable<double> SolverRelativeTolerance { get; set; }
Property Value
UseResidualsScaling
Selecting this option will scale the iterative solution residuals by the area of each element. By doing so, the residual becomes more indicative of its influence across the input surface since it is now viewed relative to the element size.
Declaration
public bool UseResidualsScaling { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
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