Class TransientSolverOptions

Inheritance

System.Object

System.MarshalByRefObject

SMT.MastaAPIUtility.MarshalByRefObjectPermanent

APIBase

TransientSolverOptions

Implements

System.IEquatable<APIBase>

Inherited Members

APIBase.DisconnectFromMASTA()

APIBase.GetProperty<T>(String)

APIBase.SetProperty(String, Object)

APIBase.cacheRpds

APIBase.clearCachedRpds()

APIBase.getNamedObjectList<TElementType>(String)

APIBase.getExpandableProperty<TReturnType>(String)

APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])

APIBase.callPartialMethod<T>(String, T)

APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)

APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)

APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)

APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)

APIBase.getPartialProperty(String)

APIBase.setPartialProperty(String, Object)

APIBase.IsValid(String)

APIBase.IsReadOnly(String)

APIBase.isInvalid

APIBase.DocumentationUrl()

APIBase.ToString()

APIBase.RunPython<T>(String, String, Object)

APIBase.RunPythonCode<T>(String, String, Object)

APIBase.RunPythonCode<T>(String)

APIBase.RunPython<T>(String, String)

APIBase.CreateObjRef(Type)

APIBase.RunPython(String, String, Object)

APIBase.createWrappedRange(Double, Double)

APIBase.createWrappedVector2D(Double, Double)

APIBase.createWrappedPosition3D(Double, Double, Double)

APIBase.Equals(APIBase)

APIBase.GetHashCode()

APIBase.Equals(Object)

SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()

Namespace: SMT.MastaAPI.NodalAnalysis

Assembly: SMT.MastaAPI.13.0.dll

Syntax

public class TransientSolverOptions : APIBase, IEquatable<APIBase>

Fields

_parent

Declaration

protected readonly APIBase _parent

Field Value

Type	Description
APIBase

Properties

AbsoluteToleranceAngularVelocityForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the absolute change in the angular velocity is less than this value.

Measurement: AngularVelocity

Declaration

public double AbsoluteToleranceAngularVelocityForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceAngularVelocityForStep

When using a variable time step the absolute error in the angular velocity is kept below this value.

Measurement: AngularVelocity

Declaration

public double AbsoluteToleranceAngularVelocityForStep { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceLagrangeForceForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the absolute change in the Lagrange force is less than this value.

Measurement: Force

Declaration

public double AbsoluteToleranceLagrangeForceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceLagrangeMomentForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the absolute change in the Lagrange moment is less than this value.

Measurement: Torque

Declaration

public double AbsoluteToleranceLagrangeMomentForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceSimple

Scaling for absolute tolerances.

Declaration

public double AbsoluteToleranceSimple { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceTemperatureForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the absolute change in the temperature is less than this value.

Measurement: TemperatureDifference

Declaration

public double AbsoluteToleranceTemperatureForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceTemperatureForStep

When using a variable time step the absolute error in the temperature is kept below this value.

Measurement: TemperatureDifference

Declaration

public double AbsoluteToleranceTemperatureForStep { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceTranslationalVelocityForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the absolute change in the translational velocity is less than this value.

Measurement: VelocitySmall

Declaration

public double AbsoluteToleranceTranslationalVelocityForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

AbsoluteToleranceTranslationalVelocityForStep

When using a variable time step the absolute error in the translational velocity is kept below this value.

Measurement: VelocitySmall

Declaration

public double AbsoluteToleranceTranslationalVelocityForStep { get; set; }

Property Value

Type	Description
System.Double

DampingScalingFactor

Maximum scaling factor applied to the damping during the initial transients. The extra damping is only applied to the Rayleigh damping β terms so that the mean load on the system is correct.

Declaration

public double DampingScalingFactor { get; set; }

Property Value

Type	Description
System.Double

DampingScalingForInitialTransients

Options other than 'None' add additional damping to the system during the initial transient period. 'Linear' uses a linear scaling for the additional damping with a maximum at the start and dropping to zero at time 0. The extra damping is only applied to the Rayleigh damping β terms so that the mean load on the system is correct.

Declaration

public DampingScalingTypeForInitialTransients DampingScalingForInitialTransients { get; set; }

Property Value

Type	Description
DampingScalingTypeForInitialTransients

EndTime

The stop time for the analysis. Note that the total time simulated may be longer if a time for initial transients is specified.

Measurement: TimeShort

Declaration

public double EndTime { get; set; }

Property Value

Type	Description
System.Double

IntegrationMethod

Method used to solve the equations of motion.

Declaration

public EnumWithSelectedValue<IntegrationMethod> IntegrationMethod { get; set; }

Property Value

Type	Description
EnumWithSelectedValue<IntegrationMethod>

LimitTimeStepForFinalResults

If this option is selected, an alternative maximum time step can be specified that is used after a specified time. This can be used to quickly get up to an interesting point in the analysis by using a coarse time step and then using a small time step to obtain detailed results.

Declaration

public bool LimitTimeStepForFinalResults { get; set; }

Property Value

Type	Description
System.Boolean

LogInitialTransients

If this option is selected, initial transients will also be logged

Declaration

public bool LogInitialTransients { get; set; }

Property Value

Type	Description
System.Boolean

MaximumNumberOfTimeSteps

The analysis will stop if this number of time steps is reached even if the end time has not been reached.

Declaration

public int MaximumNumberOfTimeSteps { get; set; }

Property Value

Type	Description
System.Int32

MaximumTimeStep

The time step will not exceed this value even if the error would allow it too. It may be necessary to reduce this in order to capture high frequency events that do not have a large influence on the system evolution.

Measurement: TimeShort

Declaration

public double MaximumTimeStep { get; set; }

Property Value

Type	Description
System.Double

MaximumTimeStepForFinalResults

The maximum time step to use when obtaining detailed results.

Measurement: TimeShort

Declaration

public double MaximumTimeStepForFinalResults { get; set; }

Property Value

Type	Description
System.Double

MinimumStepBetweenResults

The minimum time step between successive logged values.

Measurement: TimeShort

Declaration

public double MinimumStepBetweenResults { get; set; }

Property Value

Type	Description
System.Double

MinimumTimeStep

The smallest the time step is allowed to be in order to meet the error tolerance.

Measurement: TimeVeryShort

Declaration

public double MinimumTimeStep { get; set; }

Property Value

Type	Description
System.Double

RayleighDampingAlpha

The alpha damping parameter determines the low frequency damping of the system. The alpha damping can be safely set to zero to avoid power loss of the rigid body rotation mode of the whole model. The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters.

Measurement: InverseShortTime

Declaration

public double RayleighDampingAlpha { get; set; }

Property Value

Type	Description
System.Double

RayleighDampingBeta

The beta damping parameter mainly affects the damping of high frequency modes. Some beta damping should always be included to remove high frequency modes that are a result of high stiffnesses used to form rigid connections. The damping matrix for the model C = alphaM + betaK where M and K are the stiffness and mass matrices and alpha and beta are the Rayleigh damping parameters. Typical global values are in the range 1e-6 to 1e-4.

Measurement: TimeShort

Declaration

public double RayleighDampingBeta { get; set; }

Property Value

Type	Description
System.Double

RelativeToleranceForNewtonRaphson

When using a non-linear solver the values are treated as not changing if the relative change is less than this value.

Measurement: Percentage

Declaration

public double RelativeToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

RelativeToleranceForStep

When using a variable time step the relative error is kept below this value.

Measurement: Percentage

Declaration

public double RelativeToleranceForStep { get; set; }

Property Value

Type	Description
System.Double

RelativeToleranceSimple

Scaling for relative tolerances.

Declaration

public double RelativeToleranceSimple { get; set; }

Property Value

Type	Description
System.Double

ResidualForceToleranceForNewtonRaphson

The maximum force residual allowed for convergence when using a non-linear solver.

Measurement: Force

Declaration

public double ResidualForceToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResidualLagrangeAngularToleranceForNewtonRaphson

The maximum Lagrange angular residual allowed for convergence when using a non-linear solver.

Measurement: SmallAngle

Declaration

public double ResidualLagrangeAngularToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResidualLagrangeTranslationalToleranceForNewtonRaphson

The maximum Lagrange translational residual allowed for convergence when using a non-linear solver.

Measurement: ShortLength

Declaration

public double ResidualLagrangeTranslationalToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResidualMomentToleranceForNewtonRaphson

The maximum moment residual allowed for convergence when using a non-linear solver.

Measurement: Torque

Declaration

public double ResidualMomentToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResidualRelativeToleranceForNewtonRaphson

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 ResidualRelativeToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResidualTemperatureToleranceForNewtonRaphson

The maximum temperature residual allowed for convergence when using a non-linear solver.

Measurement: Power

Declaration

public double ResidualTemperatureToleranceForNewtonRaphson { get; set; }

Property Value

Type	Description
System.Double

ResultLoggingFrequency

Set to 'All' to log all available results. Set to 'Ignore Small Steps' to specify a minimum gap between logged values. Set to 'None' to not log any results.

Declaration

public ResultLoggingFrequency ResultLoggingFrequency { get; set; }

Property Value

Type	Description
ResultLoggingFrequency

RotateConnectionsWithBodies

If this option is selected, the constraints between bodies are rotated in time so that the correct local deflections occur on the bodies. Otherwise, a force on a shaft in the X direction, for example, will always bend the shaft in the local shaft X direction even if it is rotating.

Declaration

public bool RotateConnectionsWithBodies { get; set; }

Property Value

Type	Description
System.Boolean

SolverToleranceInputMethod

Simple method lets you specify a relative and an absolute tolerance which will scale all the tolerance values compared to their default values. The advanced method lets you specify all the required tolerances individually.

Declaration

public TransientSolverToleranceInputMethod SolverToleranceInputMethod { get; set; }

Property Value

Type	Description
TransientSolverToleranceInputMethod

Theta

Theta value used in the Wilson Theta Method

Declaration

public double Theta { get; set; }

Property Value

Type	Description
System.Double

TimeForInitialTransients

The start time for the analysis is set to t=-(Time For Initial Transients). Logging of results then begins at t=0. Anything that occurs during this initial period is not considered when calculating rating results and cannot be viewed.

Measurement: TimeShort

Declaration

public double TimeForInitialTransients { get; set; }

Property Value

Type	Description
System.Double

TimeStepLength

The time step to use if a variable time step is not being used.

Measurement: TimeVeryShort

Declaration

public double TimeStepLength { get; set; }

Property Value

Type	Description
System.Double

TimeToStartUsingFinalResultsMaximumTimeStep

The time at which to start using the 'Maximum Time Step For Final Results'.

Measurement: TimeShort

Declaration

public double TimeToStartUsingFinalResultsMaximumTimeStep { get; set; }

Property Value

Type	Description
System.Double

UseNonLinearSolverForStep

Select this to use a Newton Raphson solver to take a step.

Declaration

public bool UseNonLinearSolverForStep { get; set; }

Property Value

Type	Description
System.Boolean

Implements

System.IEquatable<T>

Extension Methods

UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)

UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)

UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)

UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)