TirePropertyNonInertialBuilder Class¶
-
class
NXOpen.Motion.
TirePropertyNonInertialBuilder
¶ Bases:
NXOpen.Motion.TirePropertyBuilder
Represents a builder for a Non-inertial Tire Property
To create a new instance of this class, use
NXOpen.Motion.TirePropertyNonInertialCollection.CreateTirePropertyNonInertialBuilder()
Default values.
Property Value AligningMomentArm.Value 0.0 (millimeters part), 0.0 (inches part) CorneringStiffness.Value 1000000.0 (millimeters part), 224808.944 (inches part) DistributedContact 0 FrictionCoefficient.Value 1.0 (millimeters part), 1.0 (inches part) NumDivisions.Value 1 (millimeters part), 1 (inches part) Radius.Value 300.0 (millimeters part), 11.811 (inches part) RollingResistance.Value 0.0 (millimeters part), 0.0 (inches part) StaticHold 1 VerticalDamping.Value 0.0 (millimeters part), 0.0 (inches part) VerticalStiffness.DataType Expression New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AligningMomentArm | Returns the aligning moment arm. |
CorneringStiffness | Returns the cornering stiffness constant |
DisplayScale | Returns or sets the icon display scale |
DistributedContact | Returns or sets the distributed contact. |
FrictionCoefficient | Returns the friction coefficient between the tire and road. |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
Name | Returns or sets the unique name of the tire property. |
NumDivisions | Returns the number of divisions. |
Radius | Returns the radius. |
RollingResistance | Returns the rolling resistance coefficient of the tire. |
StaticHold | Returns or sets the static hold. |
Tag | Returns the Tag for this object. |
VerticalDamping | Returns the vertical damping. |
VerticalStiffness | Returns the vertical stiffness. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AligningMomentArm¶
-
TirePropertyNonInertialBuilder.
AligningMomentArm
¶ Returns the aligning moment arm.
It is produced about the tire vertical axis using this coefficient and the lateral force acting at the tire/road interface.
-------------------------------------
Getter Method
Signature
AligningMomentArm
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
CorneringStiffness¶
-
TirePropertyNonInertialBuilder.
CorneringStiffness
¶ Returns the cornering stiffness constant
-------------------------------------
Getter Method
Signature
CorneringStiffness
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
DistributedContact¶
-
TirePropertyNonInertialBuilder.
DistributedContact
¶ Returns or sets the distributed contact.
If true, the Number of Divisions will be exported with a value required to be higher than 1 , otherwise a value of 0 will be exported to the solver.
-------------------------------------
Getter Method
Signature
DistributedContact
Returns: Return type: bool New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
DistributedContact
Parameters: inValue (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
FrictionCoefficient¶
-
TirePropertyNonInertialBuilder.
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”)
Name¶
-
TirePropertyNonInertialBuilder.
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”)
NumDivisions¶
-
TirePropertyNonInertialBuilder.
NumDivisions
¶ Returns the number of divisions.
When the distributed contact normal force model is to be used, this variable should be set to the number of vertical “slices” into which the tire is divided. If a simple “point-contact” normal force model is desired, this variable should be set to zero. The distributed contact model should be used when the road profile contains abrupt changes. NumDivisions should be set high enough so that each “slice” is smaller than the smallest road profile feature.
-------------------------------------
Getter Method
Signature
NumDivisions
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Radius¶
-
TirePropertyNonInertialBuilder.
Radius
¶ Returns the radius.
-------------------------------------
Getter Method
Signature
Radius
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RollingResistance¶
-
TirePropertyNonInertialBuilder.
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”)
StaticHold¶
-
TirePropertyNonInertialBuilder.
StaticHold
¶ Returns or sets the static hold.
it controls whether or not the tire should generate holding forces during static or quasistatic analysis. When this parameter is true, the tire will generate the following fictitious forces during static analysis, or during the static phase of STATIC/DYNAMIC analysis (see the System Data and Static elements documentation for more details). First, a torque is applied to the chassis to introduce stiffness for vehicle yaw motion. Finally, forces are applied in the fore-aft and lateral chassis directions in order to prevent equilibrium problems. Disabling these forces may cause the static analysis to fail. If the vehicle is on a flat road, then the fictitious forces will yield a physically meaningful static vehicle position. These forces attempt to keep the tire spin angle, chassis lateral/longitudinal postion at their initial values.
-------------------------------------
Getter Method
Signature
StaticHold
Returns: Return type: bool New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
StaticHold
Parameters: inValue (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
VerticalDamping¶
-
TirePropertyNonInertialBuilder.
VerticalDamping
¶ Returns the vertical damping.
It is used in the normal force calculation. A vertical damping coefficient defines the normal force due to vertical deflection velocity.
-------------------------------------
Getter Method
Signature
VerticalDamping
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
VerticalStiffness¶
-
TirePropertyNonInertialBuilder.
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¶
-
TirePropertyNonInertialBuilder.
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.