TirePropertyBasicParameters Class

class NXOpen.Motion.TirePropertyBasicParameters

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a TirePropertyBasicParameters builder

New in version NX11.0.0.

Properties

Property	Description
CorneringStiffness	Returns the cornering stiffness constant This parameter is only used in the Motion.TirePropertyBasic.
CorneringTableFile	Returns or sets the cornering table file.
CorneringTableProfile	Returns the cornering table profile.
FrictionCoefficient	Returns the friction coefficient between the tire and road.
LateralForceType	Returns or sets the lateral force (cornering) type.
MagicFile	Returns or sets the magic file.
Name	Returns or sets the unique name of the tire property.
Radius	Returns the radius.
RollingResistance	Returns the rolling resistance coefficient of the tire.
Tag	Returns the Tag for this object.
VerticalDamping	Returns the vertical damping.
VerticalStiffness	Returns the vertical stiffness.

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

TirePropertyBasicParametersCorneringType Enumeration

A constant will be used for the Cornering Stiffness when CorneringType is ‘Cornering’.

Property Detail

CorneringStiffness

TirePropertyBasicParameters.CorneringStiffness

Returns the cornering stiffness constant This parameter is only used in the Motion.TirePropertyBasic.

-------------------------------------

Getter Method

Signature CorneringStiffness

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CorneringTableFile

TirePropertyBasicParameters.CorneringTableFile

Returns or sets the cornering table file.

This parameter is only used by the :py:class:`Motion.TirePropertyBasic`(LMS) Tire Property. It is used to input the tire lateral force as a function of the steer slip angle and normal force. For a “spline explicit” type curve, X is the slip angle, Y is the normal force, and Z is the lateral forces. It is given as a data file.

-------------------------------------

Getter Method

Signature CorneringTableFile

Returns: Return type:str

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature CorneringTableFile

Parameters:fileName (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CorneringTableProfile

TirePropertyBasicParameters.CorneringTableProfile

Returns the cornering table profile.

-------------------------------------

Getter Method

Signature CorneringTableProfile

Returns: Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

FrictionCoefficient

TirePropertyBasicParameters.FrictionCoefficient

Returns the friction coefficient between the tire and road.

Should be greater than or equal to zero.

-------------------------------------

Getter Method

Signature FrictionCoefficient

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LateralForceType

TirePropertyBasicParameters.LateralForceType

Returns or sets the lateral force (cornering) type.

This parameter is only used by the Motion.TirePropertyBasic class.

-------------------------------------

Getter Method

Signature LateralForceType

Returns: Return type:NXOpen.Motion.TirePropertyBasicParametersCorneringType

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature LateralForceType

Parameters:type (NXOpen.Motion.TirePropertyBasicParametersCorneringType) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

MagicFile

TirePropertyBasicParameters.MagicFile

Returns or sets the magic file.

This parameter is used only by the Motion.TirePropertyMotorcycle.

A file containing coefficients for the Magic Formula formulation of lateral force, aligning torque, and longitudinal force. The coefficients are entered in free format, one-per-line, with the coefficient name first, followed by the value. Blank lines and lines starting with a semicolon (;) or asterisk (*) are ignored. The coefficient names are a single letter (A, B, or C) followed by a one-or two-digit suffix. The values presently used are A0 through A19, B0 through B13, and C0 through C26. The meaning of each coefficient is explained in the section on lateral force above. In addition, several constants can be defined to perform conversions from Simcenter model units to Magic Formula units. KFN converts normal force values, KSS converts steerslip values, KRS converts steerslip values, KCAM converts camber values, KFRC converts output force values, and KTRQ converts output torque values. For instance, a KSS value of 57.2958 might be used to convert a steerslip angle (calculated in radians) to a Magic Formula steerslip angle (in degrees). Likewise, a KTRQ value of 0.11302344 might be used to convert a Magic Formula output torque (calculated in N-m) to a Simcenter torque (in in-lb). Regardless of its use, the constant always represents the conversion factor to Magic Formula units. Example: The following set of lines are valid; This is an example lateral force coefficient A10 1.234 * This is an example longitudinal force coefficient B2 5.678E-3 This is an example aligning torque coefficient C24 9.0 * This is an example conversion factor, converting Simcenter normal forces (lb) to Magic Formula normal forces (kN) KFN 4.449741738D-3

-------------------------------------

Getter Method

Signature MagicFile

Returns: Return type:str

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature MagicFile

Parameters:fileName (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

TirePropertyBasicParameters.Name

Returns or sets the unique name of the tire property.

This must be set after this builder is attached to its owner.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Radius

TirePropertyBasicParameters.Radius

Returns the radius.

-------------------------------------

Getter Method

Signature Radius

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

RollingResistance

TirePropertyBasicParameters.RollingResistance

Returns the rolling resistance coefficient of the tire.

It is used to calculate a force as a function of the normal force. This adds to the longitudinal force acting as the tire/road interface. This represents parasitic longitudinal force due to carcass deformation losses, bearing friction, etc., as a fraction of normal force.

-------------------------------------

Getter Method

Signature RollingResistance

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

VerticalDamping

TirePropertyBasicParameters.VerticalDamping

Returns the vertical damping.

It is used in the normal force calculation. It is specified as an ExpressionFunctionBuilder, depening on the type a constant (expression) or a function will be used. A vertical damping coefficient defines the normal force due to vertical deflection velocity.

-------------------------------------

Getter Method

Signature VerticalDamping

Returns: Return type:NXOpen.Motion.ExpressionFunctionBuilder

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

VerticalStiffness

TirePropertyBasicParameters.VerticalStiffness

Returns the vertical stiffness.

It is specified as an ExpressionFunctionBuilder, depening on the type a constant (expression) or a function will be used. It is the tire stiffness normal to the road profile. Vertical stiffness defines tire normal force as a linear (if a constant is selected) or a non-linear (if a function is selected) function of vertical deflection.

-------------------------------------

Getter Method

Signature VerticalStiffness

Returns: Return type:NXOpen.Motion.ExpressionFunctionBuilder

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

TirePropertyBasicParameters.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.