Version: 13.0

    Show / Hide Table of Contents

    Class PowerLoadLoadCase

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    DesignEntityAnalysis
    DesignEntitySingleContextAnalysis
    PartAnalysis
    PartLoadCase
    ComponentLoadCase
    MountableComponentLoadCase
    VirtualComponentLoadCase
    PowerLoadLoadCase
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    ComponentLoadCase.AdditionalModalDampingRatio
    ComponentLoadCase.IsConnectedToGround
    ComponentLoadCase.IsTorsionallyFree
    ComponentLoadCase.MagnitudeOfRotation
    ComponentLoadCase.RayleighDampingBeta
    ComponentLoadCase.RotationAngle
    PartLoadCase.ClearUserSpecifiedExcitationDataForThisLoadCase()
    PartLoadCase.ExcitationDataIsUpToDate
    PartLoadCase.HarmonicExcitationType
    PartLoadCase.LoadCaseForHarmonicExcitationTypeAdvancedSystemDeflectionCurrentLoadCaseSetUp
    PartLoadCase.UseThisLoadCaseForAdvancedSystemDeflectionCurrentLoadCaseSetUp
    PartLoadCase.StaticLoadCase
    PartLoadCase.TimeSeriesLoadCase
    PartAnalysis.PlanetaryOriginal
    DesignEntitySingleContextAnalysis.ParametricStudyIndex1
    DesignEntitySingleContextAnalysis.ParametricStudyIndex2
    DesignEntityAnalysis._parent
    DesignEntityAnalysis.ActiveReportAsText
    DesignEntityAnalysis.Comment
    DesignEntityAnalysis.ID
    DesignEntityAnalysis.Name
    DesignEntityAnalysis.PlanetAngle
    DesignEntityAnalysis.PlanetIndex
    DesignEntityAnalysis.UniqueName
    DesignEntityAnalysis.LocalCoordinateSystem
    DesignEntityAnalysis.SafetyFactors
    DesignEntityAnalysis.AllDesignEntities
    DesignEntityAnalysis.AllStatusErrors
    DesignEntityAnalysis.HasResults
    DesignEntityAnalysis.NameWithContainer
    DesignEntityAnalysis.Status
    DesignEntityAnalysis.ReportNames
    DesignEntityAnalysis.OutputDefaultReportTo(String)
    DesignEntityAnalysis.GetDefaultReportWithEncodedImages()
    DesignEntityAnalysis.OutputActiveReportTo(String)
    DesignEntityAnalysis.OutputActiveReportAsTextTo(String)
    DesignEntityAnalysis.GetActiveReportWithEncodedImages()
    DesignEntityAnalysis.OutputNamedReportTo(String, String)
    DesignEntityAnalysis.OutputNamedReportAsMastaReport(String, String)
    DesignEntityAnalysis.OutputNamedReportAsTextTo(String, String)
    DesignEntityAnalysis.GetNamedReportWithEncodedImages(String)
    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.SystemModel.AnalysesAndResults.StaticLoads
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class PowerLoadLoadCase : VirtualComponentLoadCase, IEquatable<APIBase>

    Properties

    CoefficientOfFrictionWithGround

    Friction coefficient at the tyre contact patch.

    Declaration
    public NonDimensionalInputComponent CoefficientOfFrictionWithGround { get; }
    Property Value
    Type Description
    NonDimensionalInputComponent

    ComponentDesign

    Declaration
    public PowerLoad ComponentDesign { get; }
    Property Value
    Type Description
    PowerLoad

    ConstantResistanceCoefficient

    Measurement: Torque

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

    ConstantResistanceCoefficientTimeProfile

    Declaration
    public Vector2DListAccessor ConstantResistanceCoefficientTimeProfile { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    ConstantTorque

    Either the specified torque boundary condition applied to this power load or the reaction torque at the power load calculated during the analysis.

    Measurement: Torque

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

    DragTorqueSpecificationMethod

    Declaration
    public PowerLoadDragTorqueSpecificationMethod DragTorqueSpecificationMethod { get; set; }
    Property Value
    Type Description
    PowerLoadDragTorqueSpecificationMethod

    DragTorqueVsSpeedAndTime

    Declaration
    public GriddedSurfaceAccessor DragTorqueVsSpeedAndTime { get; set; }
    Property Value
    Type Description
    GriddedSurfaceAccessor

    DynamicTorsionalStiffness

    Measurement: AngularStiffness

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

    ElectricMachineDataSetSelector

    Declaration
    public ListWithSelectedItem<ElectricMachineDataSet> ElectricMachineDataSetSelector { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<ElectricMachineDataSet>

    EngineIdleSpeedControlPIDSettings

    Declaration
    public PIDControlSettings EngineIdleSpeedControlPIDSettings { get; }
    Property Value
    Type Description
    PIDControlSettings

    EngineThrottlePosition

    Measurement: Percentage

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

    EngineThrottleTimeProfile

    Declaration
    public Vector2DListAccessor EngineThrottleTimeProfile { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    FirstOrderLagCutoffFrequency

    Frequency at which the input torque request is attenuated by half (3 dB).

    Measurement: Frequency

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

    FirstOrderLagTimeConstant

    Set this to zero for instant torque response, or non-zero for a first order lagged torque response with this time constant.

    Measurement: TimeShort

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

    IncludeInTorsionalStiffnessCalculation

    Following a System Deflection calculation the torsional stiffness of the system is calculated between power loads. Deselect this option to not include this power load in the matrix. To get an accurate torsional stiffness for the input you should include the input power load and any outputs that can be considered grounded.

    Declaration
    public Overridable<bool> IncludeInTorsionalStiffnessCalculation { get; set; }
    Property Value
    Type Description
    Overridable<System.Boolean>

    InitialAngularAcceleration

    Measurement: AngularAcceleration

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

    InitialAngularDisplacement

    Measurement: Angle

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

    InitialAngularVelocity

    Measurement: AngularVelocity

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

    IsWheelUsingStaticFrictionInitially

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

    LinearResistanceCoefficient

    Measurement: LinearAngularDamping

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

    LinearResistanceCoefficientTimeProfile

    Declaration
    public Vector2DListAccessor LinearResistanceCoefficientTimeProfile { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    MaximumThrottleInDriveCycle

    Measurement: Percentage

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

    PIDControlSettings

    Declaration
    public PIDControlSettings PIDControlSettings { get; }
    Property Value
    Type Description
    PIDControlSettings

    Power

    Either the specified power boundary condition or the calculated result from the analysis. A positive sign indicates that this power load puts power into the transmission from an external source.

    Measurement: Power

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

    PowerLoadForPIDControl

    The speed of the selected power load is used as the input to the PID controller

    Declaration
    public ListWithSelectedItem<string> PowerLoadForPIDControl { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    ProportionOfVehicleWeightCarried

    Measurement: Percentage

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

    QuadraticResistanceCoefficient

    Measurement: QuadraticAngularDamping

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

    QuadraticResistanceCoefficientTimeProfile

    Declaration
    public Vector2DListAccessor QuadraticResistanceCoefficientTimeProfile { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    SpecifiedAngleForInputTorque

    Measurement: Angle

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

    SpecifiedTimeForInputTorque

    Measurement: Time

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

    SpecifyInitialAcceleration

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

    SpecifyInitialDisplacement

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

    SpecifyInitialVelocity

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

    Speed

    Either the specified speed boundary condition on this power load or the speed of the power load calculated during the analysis.

    Measurement: AngularVelocity

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

    SpeedVsTime

    Declaration
    public Vector2DListAccessor SpeedVsTime { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    SystemDeflectionTorqueAlsoAppliesToAdvancedSystemDeflection

    If this is selected then the torque used in Advanced System Deflection will be the same as in System Deflection. If this is not selected then then Advanced System Deflection will use a different torque for each sub-step based on the time of the step.

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

    SystemDeflectionTorqueMethod

    System Deflection and Power Flow require a single torque value for the analysis. This option determines how this single value is obtained when there is more than one input value. This will also be the torque used in analyses that depend on these such as Harmonic Response.

    Declaration
    public EnumWithSelectedValue<TorqueSpecificationForSystemDeflection> SystemDeflectionTorqueMethod { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<TorqueSpecificationForSystemDeflection>

    TargetEngineIdleSpeed

    Measurement: AngularVelocity

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

    TargetSpeed

    Measurement: AngularVelocity

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

    TargetSpeedInputType

    Declaration
    public PowerLoadPIDControlSpeedInputType TargetSpeedInputType { get; set; }
    Property Value
    Type Description
    PowerLoadPIDControlSpeedInputType

    TargetSpeedVsTime

    Declaration
    public Vector2DListAccessor TargetSpeedVsTime { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    Torque

    Either the specified torque boundary condition applied to this power load or the reaction torque at the power load calculated during the analysis.

    Measurement: Torque

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

    TorqueInputMethod

    Method for entering the torque data for this power load.

    Declaration
    public EnumWithSelectedValue<PowerLoadInputTorqueSpecificationMethod> TorqueInputMethod { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<PowerLoadInputTorqueSpecificationMethod>

    TorqueTimeProfileRepeats

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

    TorqueVsAngle

    Declaration
    public Vector2DListAccessor TorqueVsAngle { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    TorqueVsAngleAndSpeed

    Declaration
    public GriddedSurfaceAccessor TorqueVsAngleAndSpeed { get; set; }
    Property Value
    Type Description
    GriddedSurfaceAccessor

    TorqueVsTime

    Declaration
    public Vector2DListAccessor TorqueVsTime { get; set; }
    Property Value
    Type Description
    Vector2DListAccessor

    TotalMeanRotorXForceOverAllNodes

    Measurement: Force

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

    TotalMeanRotorYForceOverAllNodes

    Measurement: Force

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

    UnbalancedMagneticPullStiffness

    A positive value should be entered for the force per unit displacement of unbalanced magnetic pull. This will be correctly accounted for as a negative stiffness in the system model. If the power load is not connected to a stator, the negative stiffness is applied between the Power Load and a grounded node and acts on the shaft only. Otherwise it is applied between rotor and stator where the connection to stator uses a force distributed constraint.

    Measurement: LinearStiffness

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

    UseEngineIdleSpeedControl

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

    UseTimeDependentConstantResistanceCoefficient

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

    UseTimeDependentLinearResistanceCoefficient

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

    UseTimeDependentQuadraticResistanceCoefficient

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

    UseTimeDependentThrottle

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

    VehicleSpeedToStartIdleControl

    Measurement: Velocity

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

    VehicleSpeedToStopIdleControl

    Measurement: Velocity

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

    VelocityFirstOrderLagCutoffFrequency

    Frequency at which the velocity is attenuated by half (3 dB).

    Measurement: Frequency

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

    VelocityFirstOrderLagTimeConstant

    Set this to zero for instant torque response, or non-zero for a first order lagged torque response with this time constant.

    Measurement: TimeShort

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

    WheelSlipModel

    Declaration
    public WheelSlipType WheelSlipModel { get; set; }
    Property Value
    Type Description
    WheelSlipType

    WheelStaticToDynamicFrictionRatio

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

    WheelToVehicleStiffness

    Measurement: AngularStiffness

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

    Methods

    GetHarmonicLoadDataForImport()

    Declaration
    public ElectricMachineHarmonicLoadData GetHarmonicLoadDataForImport()
    Returns
    Type Description
    ElectricMachineHarmonicLoadData

    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>>)
    Back to top