TirePropertyCdBuilder Class

class NXOpen.Motion.TirePropertyCdBuilder

Bases: NXOpen.Motion.TirePropertyBuilder

Represents a Motion.TirePropertyCd builder

To create a new instance of this class, use NXOpen.Motion.TirePropertyCdCollection.CreateTirePropertyCdBuilder()

Default values.

Property Value
AmbientTempTypeSelection TireParameterFile
AmbientTempValue.Value 0.0 (millimeters part), 0.0 (inches part)
ContactLengthWidth 0
ContactPointGlobal 0
ContactPointRoadRef 1
CorrectorIter.Value 0 (millimeters part), 0 (inches part)
EnergyLoss (deprecated) 0
Inclination 1
InflationPressureTypeSelection TireParameterFile
InflationPressureValue.Value 0.0 (millimeters part), 0.0 (inches part)
ModelTypeSelection Cdt30
RimRoadGlobal 1
RimRoadTydexW 1
RimTydexCH 1
RoadGlobal 0
SolverResults 0
StaticHold 1
StaticRadius.Value 0.1 (millimeters part), 0 (inches part)
StaticVerticalStiffness.Value 0.0 (millimeters part), 0.0 (inches part)
TimeStatistics 0
WheelGlobal 0
WheelRoadRef 0

New in version NX11.0.0.

Properties

Property Description
AmbientTempFunction Returns or sets the ambient temperature function
AmbientTempProfile Returns the Profile for Ambient Temperature.
AmbientTempTypeSelection Returns or sets the ambient temperature type.
AmbientTempValue Returns the ambient temperature constant value.
ContactKinematics Returns or sets the Contact Kinematics (Effective Rolling Radius, Slip Velocities, Surface Normal).
ContactLengthWidth Returns or sets the contact length/width.
ContactPointGlobal Returns or sets the contact point surface friction global.
ContactPointRoadRef Returns or sets the contact point surface friction road frame.
CorrectorIter Returns the corrector iterations.
DisplayScale Returns or sets the icon display scale
EnergyLoss Returns or sets the wear indicator.
EnergyLossOfSpecificEntities Returns or sets the Energy Loss Of Specific Entities.
EnergyLossPerSegment Returns or sets the Energy Loss Per Cross Section Segment Activates specific CDTire results: eloss_gl, eloss_01 .
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Inclination Returns or sets the inclination and slip angle, slip loaded radius, rim rotation.
InflationPressureFunction Returns or sets the inflation pressure function
InflationPressureProfile Returns the Profile for Inflation Pressure.
InflationPressureTypeSelection Returns or sets the inflation pressure type.
InflationPressureValue Returns the inflation pressure constant value.
ModelTypeSelection Returns or sets the CDTire model type.
Name Returns or sets the name of the Tire Property
PrimaryParamFile Returns or sets the primary parameter file.
RimRoadGlobal Returns or sets the rim road global frame.
RimRoadTydexW Returns or sets the rim road tydex-W frame.
RimTydexCH Returns or sets the rim Tydex-C and Tydex-H frames.
RoadGlobal Returns or sets the road center global.
SolverResults Returns or sets the solver results Activates specific CDTire results: Integration step size (h);Time integration error (err);
StaticHold Returns or sets the static hold.
StaticRadius Returns the static radius.
StaticVerticalStiffness Returns the static vertical stiffness.
Tag Returns the Tag for this object.
TimeStatistics Returns or sets the time statistics Activates specific CDTire results: Simulation time (time); CDTire tire model type (submodel); CDTire road model type (type); CPU time for this tire (cpu_time);
TireControlFile Returns or sets the tire control file.
WearIndicatorPerSegment Returns or sets the Wear Indicator Per Cross Section Segment.
WheelGlobal Returns or sets the wheel center global.
WheelRoadRef Returns or sets the wheel center road reference frame.

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

AmbientTempFunction

TirePropertyCdBuilder.AmbientTempFunction

Returns or sets the ambient temperature function

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

Getter Method

Signature AmbientTempFunction

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature AmbientTempFunction

Parameters:ambientTempFunction (NXOpen.Motion.MotionFunction) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

AmbientTempProfile

TirePropertyCdBuilder.AmbientTempProfile

Returns the Profile for Ambient Temperature.

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

Getter Method

Signature AmbientTempProfile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

AmbientTempTypeSelection

TirePropertyCdBuilder.AmbientTempTypeSelection

Returns or sets the ambient temperature type.

Specifies how the ambient temperature will be defined. If AmbientTempType.TireParameterFile is selected, then the ambient temperature is set in the selected tire parameter file. Otherwise, it will be defined as a constant, function, or a profile. The pressure curve defines ambient temperature as a function of simulation time.

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

Getter Method

Signature AmbientTempTypeSelection

Returns:
Return type:NXOpen.Motion.TirePropertyCdBuilderAmbientTempType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature AmbientTempTypeSelection

Parameters:ambientTempTypeSelection (NXOpen.Motion.TirePropertyCdBuilderAmbientTempType) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

AmbientTempValue

TirePropertyCdBuilder.AmbientTempValue

Returns the ambient temperature constant value.

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

Getter Method

Signature AmbientTempValue

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

ContactKinematics

TirePropertyCdBuilder.ContactKinematics

Returns or sets the Contact Kinematics (Effective Rolling Radius, Slip Velocities, Surface Normal).

Activates specific CDTire results: Effective rolling radius (eff_roll_rad);Loaded radius rate of change (radius_rate); Longitudinal slip velocity (long_slip_vel);Lateral slip velocity (lat_slip_vel); Surface normal in road frame (surf_norm_x, surf_norm_y, surf_norm_z); Longitudinal velocity (long_vel);Spin velocity (spin_vel);

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

Getter Method

Signature ContactKinematics

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature ContactKinematics

Parameters:attributeValue (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ContactLengthWidth

TirePropertyCdBuilder.ContactLengthWidth

Returns or sets the contact length/width.

Activates specific CDTire results: Contact patch length (contlength); Contact patch width (contwidth);

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

Getter Method

Signature ContactLengthWidth

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ContactLengthWidth

Parameters:contactLengthWidth (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ContactPointGlobal

TirePropertyCdBuilder.ContactPointGlobal

Returns or sets the contact point surface friction global.

Activates specific CDTire results: Global location of contact center (contact_x_world, contact_y_world, contact_z_world); Coefficient of friction at contact point (mu);

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

Getter Method

Signature ContactPointGlobal

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ContactPointGlobal

Parameters:contactPointGlobal (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ContactPointRoadRef

TirePropertyCdBuilder.ContactPointRoadRef

Returns or sets the contact point surface friction road frame.

Activates specific CDTire results: x, y, or z-component of contact center position wrt Road Body (contact_x, contact_y, contact_z); Coefficient of friction at contact point (mu);

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

Getter Method

Signature ContactPointRoadRef

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ContactPointRoadRef

Parameters:contactPointRoadRef (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CorrectorIter

TirePropertyCdBuilder.CorrectorIter

Returns the corrector iterations.

Define the maximum number of corrector iterations to be performed at each simulation time step in the CDTire internal PECE integrator.

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

Getter Method

Signature CorrectorIter

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

EnergyLoss

TirePropertyCdBuilder.EnergyLoss

Returns or sets the wear indicator.

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

Getter Method

Signature EnergyLoss

Returns:
Return type:bool

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use TirePropertyCdBuilder.WearIndicatorPerSegment() instead.

License requirements: None.

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

Setter Method

Signature EnergyLoss

Parameters:attributeValue (bool) –

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use TirePropertyCdBuilder.WearIndicatorPerSegment() instead.

License requirements: mechanisms (“MECHANISMS”)

EnergyLossOfSpecificEntities

TirePropertyCdBuilder.EnergyLossOfSpecificEntities

Returns or sets the Energy Loss Of Specific Entities.

Activates specific CDTire results: (el_all, el_rubber_circ_damp, el_rubber_lat_damp, el_rubber_diag_damp, el_rubber_shear_damp, el_carcass_damp, el_capply_damp, el_belt_damp, el_bend_damp_x, el_bend_damp_y, el_bend_damp_xy, el_tread_slip, el_tread_radial_damp, el_tread_inner_frict);

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

Getter Method

Signature EnergyLossOfSpecificEntities

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature EnergyLossOfSpecificEntities

Parameters:attributeValue (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

EnergyLossPerSegment

TirePropertyCdBuilder.EnergyLossPerSegment

Returns or sets the Energy Loss Per Cross Section Segment Activates specific CDTire results: eloss_gl, eloss_01 .

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

Getter Method

Signature EnergyLossPerSegment

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature EnergyLossPerSegment

Parameters:attributeValue (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Inclination

TirePropertyCdBuilder.Inclination

Returns or sets the inclination and slip angle, slip loaded radius, rim rotation.

Activates specific CDTire results: Deflected tire radius (dynrad); y-component of rotational rim velocity wrt Tire Body (wy); Inclination angle (gamma); Slip angle (alpha); Longitudinal slip (longslip);

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

Getter Method

Signature Inclination

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Inclination

Parameters:inclination (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

InflationPressureFunction

TirePropertyCdBuilder.InflationPressureFunction

Returns or sets the inflation pressure function

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

Getter Method

Signature InflationPressureFunction

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature InflationPressureFunction

Parameters:inflationPressureFunction (NXOpen.Motion.MotionFunction) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

InflationPressureProfile

TirePropertyCdBuilder.InflationPressureProfile

Returns the Profile for Inflation Pressure.

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

Getter Method

Signature InflationPressureProfile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

InflationPressureTypeSelection

TirePropertyCdBuilder.InflationPressureTypeSelection

Returns or sets the inflation pressure type.

Specifies how the tire pressure will be defined. If InflationPressureType.TireParameterFile is selected, then the tire pressure is set in the selected tire parameter file. Otherwise, it will be defined as a constant, function, or a profile. The pressure curve defines tire pressure as a function of simulation time.

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

Getter Method

Signature InflationPressureTypeSelection

Returns:
Return type:NXOpen.Motion.TirePropertyCdBuilderInflationPressureType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature InflationPressureTypeSelection

Parameters:inflationPressureTypeSelection (NXOpen.Motion.TirePropertyCdBuilderInflationPressureType) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

InflationPressureValue

TirePropertyCdBuilder.InflationPressureValue

Returns the inflation pressure constant value.

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

Getter Method

Signature InflationPressureValue

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

ModelTypeSelection

TirePropertyCdBuilder.ModelTypeSelection

Returns or sets the CDTire model type.

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

Getter Method

Signature ModelTypeSelection

Returns:
Return type:NXOpen.Motion.TirePropertyCdBuilderModelType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ModelTypeSelection

Parameters:modelTypeSelection (NXOpen.Motion.TirePropertyCdBuilderModelType) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

TirePropertyCdBuilder.Name

Returns or sets the name of the Tire Property

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PrimaryParamFile

TirePropertyCdBuilder.PrimaryParamFile

Returns or sets the primary parameter file.

The tire parameter file describes the properties of the tire. The number and location of the contained parameters depend on the used tire model. The file extension depends upon the selected Model Type.

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

Getter Method

Signature PrimaryParamFile

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature PrimaryParamFile

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

RimRoadGlobal

TirePropertyCdBuilder.RimRoadGlobal

Returns or sets the rim road global frame.

Activates specific CDTire results: Global x, y, or z-component of tire force/torque applied to Tire Body (tb_gl_fx, tb_gl_fy, tb_gl_fz, tb_gl_tx, tb_gl_ty, tb_gl_tz);

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

Getter Method

Signature RimRoadGlobal

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RimRoadGlobal

Parameters:rimRoadGlobal (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

RimRoadTydexW

TirePropertyCdBuilder.RimRoadTydexW

Returns or sets the rim road tydex-W frame.

Activates specific CDTire results: X, y, or z-component of tire force/torque applied to Tire body, in Tydex-W frame (tb_tw_fx, tb_tw_fy, tb_tw_fz, tb_tw_tx, tb_tw_ty, tb_tw_tz); X, y, or z-component of contact force/torque applied to Road body, in Tydex-W frame (rb_tw_fx, rb_tw_fy, rb_tw_fz, rb_tw_tx, rb_tw_ty, rb_tw_tz);

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

Getter Method

Signature RimRoadTydexW

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RimRoadTydexW

Parameters:rimRoadTydexW (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

RimTydexCH

TirePropertyCdBuilder.RimTydexCH

Returns or sets the rim Tydex-C and Tydex-H frames.

Activates specific CDTire results: x, y, or z-component of tire force applied to Tire Body wrt Tydex-C coordinate system (tb_tc_fx, tb_tc_fy, tb_tc_fz, tb_tc_tx, tb_tc_ty, tb_tc_tz); x, y, or z-component of tire force applied to Tire Body wrt Tydex-H coordinate system (tb_th_fx, tb_th_fy, tb_th_fz, tb_th_tx, tb_th_ty, tb_th_tz);.

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

Getter Method

Signature RimTydexCH

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RimTydexCH

Parameters:rimTydexCH (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

RoadGlobal

TirePropertyCdBuilder.RoadGlobal

Returns or sets the road center global.

Activates specific CDTire results: Vector from road axis system to rim center, in road axis system coordinates (roadx_world, roady_world, roadz_world); Euler parameter orientation coordinates of rim axis system with respect to road axis system (roade0_world, roade1_world, roade2_world, roade3_world); Velocity of rim center, relative to road axis system, in road axis system coordinates (roadxd_world, roadyd_world, roadzd_world); Angular velocity of rim relative to road axis system, in road axis system coordinates (roadwx_world, roadwy_world, roadwz_world);

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

Getter Method

Signature RoadGlobal

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RoadGlobal

Parameters:roadGlobal (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

SolverResults

TirePropertyCdBuilder.SolverResults

Returns or sets the solver results Activates specific CDTire results: Integration step size (h);Time integration error (err);

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

Getter Method

Signature SolverResults

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature SolverResults

Parameters:solverResults (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

StaticHold

TirePropertyCdBuilder.StaticHold

Returns or sets the static hold.

Enables or disables holding forces during static analysis. These holding forces are applied to prevent add tire spin and gross chassis motion (X and Y translation and yaw with respect to the road “up” vector) stiffness in order to improve convergence during static analysis.

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

Getter Method

Signature StaticHold

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature StaticHold

Parameters:staticHold (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

StaticRadius

TirePropertyCdBuilder.StaticRadius

Returns the static radius.

Approximate radius of the tire. Used only for the purpose of including additional stabilizing forces during static analysis if TirePropertyCdBuilder.StaticHold`() is true.

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

Getter Method

Signature StaticRadius

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

StaticVerticalStiffness

TirePropertyCdBuilder.StaticVerticalStiffness

Returns the static vertical stiffness.

Specifies the vertical stiffness only used in static equilibrating force calculations. Used only for the purpose of including additional stabilizing forces during static analysis if TirePropertyCdBuilder.StaticHold`() is true.

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

Getter Method

Signature StaticVerticalStiffness

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

TimeStatistics

TirePropertyCdBuilder.TimeStatistics

Returns or sets the time statistics Activates specific CDTire results: Simulation time (time); CDTire tire model type (submodel); CDTire road model type (type); CPU time for this tire (cpu_time);

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

Getter Method

Signature TimeStatistics

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TimeStatistics

Parameters:timeStatistics (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

TireControlFile

TirePropertyCdBuilder.TireControlFile

Returns or sets the tire control file.

The Tire Control File contains integrator control, adaptivity control and monitor control parameter.

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

Getter Method

Signature TireControlFile

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TireControlFile

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

WearIndicatorPerSegment

TirePropertyCdBuilder.WearIndicatorPerSegment

Returns or sets the Wear Indicator Per Cross Section Segment.

Activates specific CDTire results: (wear_ind_gl, wear_ind_01 … wear_ind_29);

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

Getter Method

Signature WearIndicatorPerSegment

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature WearIndicatorPerSegment

Parameters:attributeValue (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

WheelGlobal

TirePropertyCdBuilder.WheelGlobal

Returns or sets the wheel center global.

Activates specific CDTire results: Global position of rim center (wheelx_world, wheely_world, wheelz_world); Euler parameters orientation coordinates of rim center axis system with respect to world (wheele0_world, wheele1_world, wheele2_world, wheele4_world); Global velocity of rim center (wheelxd_world, wheelyd_world, wheelzd_world); Global angular velocity of rim center (wheelwx_world, wheelwy_world, wheelwz_world);.

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

Getter Method

Signature WheelGlobal

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature WheelGlobal

Parameters:wheelGlobal (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

WheelRoadRef

TirePropertyCdBuilder.WheelRoadRef

Returns or sets the wheel center road reference frame.

Activates specific CDTire results: Vector from road axis system to rim center, in road axis system coordinates (wheelx_road, wheely_road, wheelz_road); Euler parameter orientation coordinates of rim axis system with respect to road axis system (wheele0_road, wheele1_road, wheele2_road, wheele3_road); Velocity of rim center, relative to road axis system, in road axis system coordinates (wheelxd_road, wheelyd_road, wheelzd_road); Angular velocity of rim relative to road axis system, in road axis system coordinates (wheelwx_road, wheelwy_road, wheelwz_road);

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

Getter Method

Signature WheelRoadRef

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature WheelRoadRef

Parameters:wheelRoadRef (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

TirePropertyCdBuilder.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.