NXOpen::Motion::TirePropertyAdvancedParameters Class Reference

Represents a TirePropertyAdvancedParameters builder
Created in NX11.0.0. More...

Inheritance diagram for NXOpen::Motion::TirePropertyAdvancedParameters:

Public Types
enum	ContactType { ContactTypeFunction, ContactTypeProfile }
	The block type can be Function when a spline curve is used or Profile when a profile is used. More...
enum	FrictType { FrictTypeFunction, FrictTypeProfile }
	The block type can be Function when a spline curve is used or Profile when a profile is used. More...
enum	RollingType { RollingTypeNone, RollingTypeBias, RollingTypeBelted }
	the rolling radius type. More...
enum	SurfType {   SurfTypeSimple, SurfTypeHard, SurfTypeSoil, SurfTypeVelFrictCurve,   SurfTypeFrictCurve, SurfTypeVelFrictSurface, SurfTypeFrictSurface }
	the type of surface interaction calculations used. More...

Public Member Functions
NXOpen::Expression *	AligningMomentArm ()
	Returns the aligning moment arm. More...
NXOpen::Expression *	ConeIndex ()
	Returns the cone index. More...
NXOpen::Motion::MotionFunction *	ContactAreaFunction ()
	Returns the contact area function. More...
NXOpen::Motion::SelectFieldData *	ContactAreaProfile ()
	Returns the Contact Area Profile. More...
NXOpen::Motion::TirePropertyAdvancedParameters::ContactType	ContactAreaType ()
	Returns the contact area type. More...
bool	DistributedContact ()
	Returns the distributed contact Created in NX11.0.0. More...
NXOpen::Motion::MotionFunction *	FrictionFunction ()
	Returns the friction function. More...
NXOpen::Motion::SelectFieldData *	FrictionProfile ()
	Returns the friction Profile. More...
NXString	FrictionSurfaceFile ()
	Returns the friction surface file Created in NX11.0.0. More...
NXOpen::Motion::SelectFieldData *	FrictionSurfaceProfile ()
	Returns the friction surface profile Created in NX12.0.0. More...
NXOpen::Motion::TirePropertyAdvancedParameters::FrictType	FrictionType ()
	Returns the friction type. More...
NXOpen::Expression *	NumDivisions ()
	Returns the number of divisions. More...
NXOpen::Expression *	RelaxationLength ()
	Returns the relaxation length. More...
NXOpen::Motion::TirePropertyAdvancedParameters::RollingType	RollingRadiusType ()
	Returns the rolling radius type. More...
NXOpen::Expression *	RollingRadiusValue ()
	Returns the rolling radius of the tire. More...
NXOpen::Expression *	SectionHeight ()
	Returns the section height. More...
NXOpen::Expression *	SectionWidth ()
	Returns the section width. More...
void	SetContactAreaFunction (NXOpen::Motion::MotionFunction *func)
	Sets the contact area function. More...
void	SetContactAreaType (NXOpen::Motion::TirePropertyAdvancedParameters::ContactType type)
	Sets the contact area type. More...
void	SetDistributedContact (bool inValue)
	Sets the distributed contact Created in NX11.0.0. More...
void	SetFrictionFunction (NXOpen::Motion::MotionFunction *func)
	Sets the friction function. More...
void	SetFrictionSurfaceFile (const NXString &fileName)
	Sets the friction surface file Created in NX11.0.0. More...
void	SetFrictionSurfaceFile (const char *fileName)
	Sets the friction surface file Created in NX11.0.0. More...
void	SetFrictionType (NXOpen::Motion::TirePropertyAdvancedParameters::FrictType type)
	Sets the friction type. More...
void	SetRollingRadiusType (NXOpen::Motion::TirePropertyAdvancedParameters::RollingType type)
	Sets the rolling radius type. More...
void	SetStaticHold (bool inValue)
	Sets the static hold. More...
void	SetSurfaceType (NXOpen::Motion::TirePropertyAdvancedParameters::SurfType type)
	Sets the surface type. More...
bool	StaticHold ()
	Returns the static hold. More...
NXOpen::Motion::TirePropertyAdvancedParameters::SurfType	SurfaceType ()
	Returns the surface type. More...
NXOpen::Expression *	TransDampingDeflection ()
	Returns the transitional damping deflection. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a TirePropertyAdvancedParameters builder
Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::TirePropertyAdvancedParameters::ContactType

The block type can be Function when a spline curve is used or Profile when a profile is used.

Enumerator
ContactTypeFunction	function
ContactTypeProfile	profile

enum NXOpen::Motion::TirePropertyAdvancedParameters::FrictType

The block type can be Function when a spline curve is used or Profile when a profile is used.

Enumerator
FrictTypeFunction	function
FrictTypeProfile	profile

enum NXOpen::Motion::TirePropertyAdvancedParameters::RollingType

the rolling radius type.

When 'None' is selected a 0.0 value is exported for the Rolling Radius parameter. 'Bias' is used for a bias-ply tire and 'Belted' is for a belted radial tire.

Enumerator
RollingTypeNone	none
RollingTypeBias	bias
RollingTypeBelted	belted

enum NXOpen::Motion::TirePropertyAdvancedParameters::SurfType

the type of surface interaction calculations used.

If type Simple is selected, the longitudinal friction coefficient is a function of the rolling slip only. If type Hard is selected, the longitudinal friction coefficient is a function of the rolling slip, section width, and the surface hardness. If type Soil is selected, the longitudinal friction coefficient is a function of the rolling slip, section width, section height, and the cone index. If FrictCurve (Rolling Slip Friction Curve) is selected, a curve is used to describe the longitudinal friction coefficient as a function of rolling slip (using the friction coefficient parameter from Standard Tire Property). If VelFrictCurve (Rolling Slip Velocity Friction Curve) is selected, a curve is used to describe the longitudinal friction coefficient as a function of tirepatch rolling slip velocity (using the friction coefficient parameter from the TirePropertyBasicParameters) If FrictSurface or VelFrictSurface are selected, spline surface from data table files are used instead of curves. In this case an additional contact area curve can be selected. If Soil is selected, the rolling resistance is calculated as part of the longitudinal friction coefficient formula; in all other case, the nominal rolling resistance coefficient (Rolling Resistence variable) is used.

Enumerator
SurfTypeSimple	simple
SurfTypeHard	hard
SurfTypeSoil	soil
SurfTypeVelFrictCurve	vel frict curve
SurfTypeFrictCurve	frict curve
SurfTypeVelFrictSurface	vel frict surface
SurfTypeFrictSurface	frict surface

Member Function Documentation

NXOpen::Expression* NXOpen::Motion::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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::TirePropertyAdvancedParameters::ContactAreaFunction

(

)

Returns the contact area function.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::TirePropertyAdvancedParameters::ContactAreaProfile

(

)

Returns the Contact Area Profile.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyAdvancedParameters::ContactType NXOpen::Motion::TirePropertyAdvancedParameters::ContactAreaType

(

)

Returns the contact area type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyAdvancedParameters::DistributedContact

(

)

Returns the distributed contact
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::TirePropertyAdvancedParameters::FrictionFunction

(

)

Returns the friction function.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::TirePropertyAdvancedParameters::FrictionProfile

(

)

Returns the friction Profile.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyAdvancedParameters::FrictionSurfaceFile

(

)

Returns the friction surface file
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::TirePropertyAdvancedParameters::FrictionSurfaceProfile

(

)

Returns the friction surface profile
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyAdvancedParameters::FrictType NXOpen::Motion::TirePropertyAdvancedParameters::FrictionType

(

)

Returns the friction type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyAdvancedParameters::RollingType NXOpen::Motion::TirePropertyAdvancedParameters::RollingRadiusType

(

)

Returns the rolling radius type.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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).

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyAdvancedParameters::SectionWidth

(

)

Returns the section width.

This is used by the Hard and Soil surface models.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::TirePropertyAdvancedParameters::SetContactAreaFunction

(

NXOpen::Motion::MotionFunction *

func

)

Sets the contact area function.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

func

func

void NXOpen::Motion::TirePropertyAdvancedParameters::SetContactAreaType

(

NXOpen::Motion::TirePropertyAdvancedParameters::ContactType

type

)

Sets the contact area type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type

type

void NXOpen::Motion::TirePropertyAdvancedParameters::SetDistributedContact

(

bool

inValue

)

Sets the distributed contact
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

void NXOpen::Motion::TirePropertyAdvancedParameters::SetFrictionFunction

(

NXOpen::Motion::MotionFunction *

func

)

Sets the friction function.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

func

func

void NXOpen::Motion::TirePropertyAdvancedParameters::SetFrictionSurfaceFile

(

const NXString &

fileName

)

Sets the friction surface file
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

fileName

filename

void NXOpen::Motion::TirePropertyAdvancedParameters::SetFrictionSurfaceFile

(

const char *

fileName

)

Sets the friction surface file
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

fileName

filename

void NXOpen::Motion::TirePropertyAdvancedParameters::SetFrictionType

(

NXOpen::Motion::TirePropertyAdvancedParameters::FrictType

type

)

Sets the friction type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type

type

void NXOpen::Motion::TirePropertyAdvancedParameters::SetRollingRadiusType

(

NXOpen::Motion::TirePropertyAdvancedParameters::RollingType

type

)

Sets the rolling radius type.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type

type

void NXOpen::Motion::TirePropertyAdvancedParameters::SetStaticHold

(

bool

inValue

)

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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

void NXOpen::Motion::TirePropertyAdvancedParameters::SetSurfaceType

(

NXOpen::Motion::TirePropertyAdvancedParameters::SurfType

type

)

Sets the surface type.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type

type

bool NXOpen::Motion::TirePropertyAdvancedParameters::StaticHold

(

)

Returns 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.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyAdvancedParameters::SurfType NXOpen::Motion::TirePropertyAdvancedParameters::SurfaceType

(

)

Returns the surface type.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::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.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual bool NXOpen::Motion::TirePropertyAdvancedParameters::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• Motion_TirePropertyAdvancedParameters.hxx