TirePropertyAdvancedParameters Class¶
-
class
NXOpen.Motion.
TirePropertyAdvancedParameters
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a TirePropertyAdvancedParameters builder
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AligningMomentArm | Returns the aligning moment arm. |
ConeIndex | Returns the cone index. |
ContactAreaFunction | Returns or sets the contact area function. |
ContactAreaProfile | Returns the Contact Area Profile. |
ContactAreaType | Returns or sets the contact area type. |
DistributedContact | Returns or sets the distributed contact |
FrictionFunction | Returns or sets the friction function. |
FrictionProfile | Returns the friction Profile. |
FrictionSurfaceFile | Returns or sets the friction surface file |
FrictionSurfaceProfile | Returns the friction surface profile |
FrictionType | Returns or sets the friction type. |
NumDivisions | Returns the number of divisions. |
RelaxationLength | Returns the relaxation length. |
RollingRadiusType | Returns or sets the rolling radius type. |
RollingRadiusValue | Returns the rolling radius of the tire. |
SectionHeight | Returns the section height. |
SectionWidth | Returns the section width. |
StaticHold | Returns or sets the static hold. |
SurfaceType | Returns or sets the surface type. |
Tag | Returns the Tag for this object. |
TransDampingDeflection | Returns the transitional damping deflection. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
TirePropertyAdvancedParametersContactType Enumeration | The block type can be Function when a spline curve is used or Profile when a profile is used. |
TirePropertyAdvancedParametersFrictType Enumeration | The block type can be Function when a spline curve is used or Profile when a profile is used. |
TirePropertyAdvancedParametersRollingType Enumeration | the rolling radius type. |
TirePropertyAdvancedParametersSurfType Enumeration | the type of surface interaction calculations used. |
Property Detail¶
AligningMomentArm¶
-
TirePropertyAdvancedParameters.
AligningMomentArm
¶ Returns the aligning moment arm.
This parameter is only used in the
Motion.TirePropertyBasic
. 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”)
ConeIndex¶
-
TirePropertyAdvancedParameters.
ConeIndex
¶ Returns the cone index.
This is an index value of the Surface type. For Soil Surface type, this value is the cone index. For Hard Surface type, this is the rubber hardness. Units are force per length squared.
-------------------------------------
Getter Method
Signature
ConeIndex
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ContactAreaFunction¶
-
TirePropertyAdvancedParameters.
ContactAreaFunction
¶ Returns or sets the contact area function.
-------------------------------------
Getter Method
Signature
ContactAreaFunction
Returns: Return type: NXOpen.Motion.MotionFunction
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
ContactAreaFunction
Parameters: func ( NXOpen.Motion.MotionFunction
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ContactAreaProfile¶
-
TirePropertyAdvancedParameters.
ContactAreaProfile
¶ Returns the Contact Area Profile.
-------------------------------------
Getter Method
Signature
ContactAreaProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
ContactAreaType¶
-
TirePropertyAdvancedParameters.
ContactAreaType
¶ Returns or sets the contact area type.
-------------------------------------
Getter Method
Signature
ContactAreaType
Returns: Return type: NXOpen.Motion.TirePropertyAdvancedParametersContactType
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
ContactAreaType
Parameters: type ( NXOpen.Motion.TirePropertyAdvancedParametersContactType
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
DistributedContact¶
-
TirePropertyAdvancedParameters.
DistributedContact
¶ Returns or sets the distributed contact
-------------------------------------
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”)
FrictionFunction¶
-
TirePropertyAdvancedParameters.
FrictionFunction
¶ Returns or sets the friction function.
-------------------------------------
Getter Method
Signature
FrictionFunction
Returns: Return type: NXOpen.Motion.MotionFunction
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
FrictionFunction
Parameters: func ( NXOpen.Motion.MotionFunction
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
FrictionProfile¶
-
TirePropertyAdvancedParameters.
FrictionProfile
¶ Returns the friction Profile.
-------------------------------------
Getter Method
Signature
FrictionProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
FrictionSurfaceFile¶
-
TirePropertyAdvancedParameters.
FrictionSurfaceFile
¶ Returns or sets the friction surface file
-------------------------------------
Getter Method
Signature
FrictionSurfaceFile
Returns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
FrictionSurfaceFile
Parameters: fileName (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
FrictionSurfaceProfile¶
-
TirePropertyAdvancedParameters.
FrictionSurfaceProfile
¶ Returns the friction surface profile
-------------------------------------
Getter Method
Signature
FrictionSurfaceProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
FrictionType¶
-
TirePropertyAdvancedParameters.
FrictionType
¶ Returns or sets the friction type.
-------------------------------------
Getter Method
Signature
FrictionType
Returns: Return type: NXOpen.Motion.TirePropertyAdvancedParametersFrictType
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
FrictionType
Parameters: type ( NXOpen.Motion.TirePropertyAdvancedParametersFrictType
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
NumDivisions¶
-
TirePropertyAdvancedParameters.
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”)
RelaxationLength¶
-
TirePropertyAdvancedParameters.
RelaxationLength
¶ Returns the relaxation length.
This value, combined with the fore/aft velocity, determines the time constant of a first-order equation, which is used to attenuate response of the lateral force and aligning torque. A value of zero results in no lag. If a variable relaxation length is desired the user can place a user defined equation in the file relaxln.f. This file can be found in the user defined subroutines directory. If a user defined relaxation length is used, then the value in the form-fill should be an approximation of the nominal value.
-------------------------------------
Getter Method
Signature
RelaxationLength
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RollingRadiusType¶
-
TirePropertyAdvancedParameters.
RollingRadiusType
¶ Returns or sets the rolling radius type.
-------------------------------------
Getter Method
Signature
RollingRadiusType
Returns: Return type: NXOpen.Motion.TirePropertyAdvancedParametersRollingType
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
RollingRadiusType
Parameters: type ( NXOpen.Motion.TirePropertyAdvancedParametersRollingType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RollingRadiusValue¶
-
TirePropertyAdvancedParameters.
RollingRadiusValue
¶ Returns the rolling radius of the tire.
This value is found by dividing the distance traveled during one rotation by 2 PI. If a value of zero is entered, the deflected radius found in the tire normal force calculation will be used to calculate the tirepatch slip and tire force application point. If a positive value is entered, this value will be used to calculate the tirepatch slip and tire force application point. If a negative value is entered, this value will be used to calculate the tirepatch slip, but the tire force application point will be at the deflected radius (this formulation simulates a tire with steel non-deformable belt).
-------------------------------------
Getter Method
Signature
RollingRadiusValue
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SectionHeight¶
-
TirePropertyAdvancedParameters.
SectionHeight
¶ Returns the section height.
This is used by the Soil surface model and is related to unloaded diameter and rim diameter. The section height is also used as the carcass diameter to calculate the lateral offset of the tire patch due to carcass roll. This is used in calculating the roll moment due to lateral offset of the tire patch.
-------------------------------------
Getter Method
Signature
SectionHeight
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SectionWidth¶
-
TirePropertyAdvancedParameters.
SectionWidth
¶ Returns the section width.
This is used by the Hard and Soil surface models.
-------------------------------------
Getter Method
Signature
SectionWidth
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
StaticHold¶
-
TirePropertyAdvancedParameters.
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”)
SurfaceType¶
-
TirePropertyAdvancedParameters.
SurfaceType
¶ Returns or sets the surface type.
-------------------------------------
Getter Method
Signature
SurfaceType
Returns: Return type: NXOpen.Motion.TirePropertyAdvancedParametersSurfType
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
SurfaceType
Parameters: type ( NXOpen.Motion.TirePropertyAdvancedParametersSurfType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
TransDampingDeflection¶
-
TirePropertyAdvancedParameters.
TransDampingDeflection
¶ Returns the transitional damping deflection.
When non-zero, this value is used to attenuate the normal damping force for small tire deflections. If a value of zero is entered, the nominal damping rate is used. The normal damping rate is found by the formula: CD (1 - e-3d/d0) where: CD is the nominal damping rate (from damping coeff or curve damping), d is the tire normal deflection, and d0 is the transitional normal damping deflection.
-------------------------------------
Getter Method
Signature
TransDampingDeflection
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
TirePropertyAdvancedParameters.
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.