tireModel Class

Use tireModel superclass to interact with tire model type subclasses

Since R2023b

Description

This class requires Extended Tire Features for Vehicle Dynamics Blockset.

Store model parameters, execute model solver computations, plot model behavior, and export model data with the tireModel superclass.

Class Attributes

Abstract

true

For information on class attributes, see Class Attributes.

Creation

You can create tire model objects in three different ways.

• Use tireModel.new to create a tire model object with default values.

• Use tireModel.builtin to create a tire model object from a built-in tire model.

• Use tireModel.import to import an existing tire model parameter set into a tire model object.

Note

Nonempty properties specified as a column vector must all be the same length.

Properties

Public Properties

Name — Model name

string scalar

Model name, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Description — Model description

string scalar

Model description, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

PRESMIN — Minimum valid tire inflation pressure

10000 (default) | scalar

Minimum valid tire inflation pressure, specified as a scalar, in Pa.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

PRESMAX — Maximum valid tire inflation pressure

1000000 (default) | scalar

Maximum valid tire inflation pressure, specified as a scalar, in Pa.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

FZMIN — Minimum allowed wheel load

100 (default) | scalar

Minimum allowed wheel load, specified as a scalar, in N.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

FZMAX — Maximum allowed wheel load

100000 (default) | scalar

Maximum allowed wheel load, specified as a scalar, in N.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

KPUMIN — Minimum valid wheel slip

-1.5 (default) | scalar

Minimum valid wheel slip, specified as a scalar, dimensionless.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

KPUMAX — Maximum valid wheel slip

1.5 (default) | scalar

Maximum valid wheel slip, specified as a scalar, dimensionless.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

ALPMIN — Minimum valid slip angle

-0.7854 (default) | scalar

Minimum valid slip angle, specified as a scalar, in rad.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

ALPMAX — Maximum valid slip angle

0.7854 (default) | scalar

Maximum valid slip angle, specified as a scalar, in rad.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

CAMMIN — Minimum valid camber angle

-0.17453 (default) | scalar

Minimum valid camber angle, specified as a scalar, in rad.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

CAMMAX — Maximum valid camber angle

0.17453 (default) | scalar

Maximum valid camber angle, specified as a scalar, in rad.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

VXLOW — Minimum valid longitudinal velocity

1 (default) | scalar

Minimum valid longitudinal velocity, specified as a scalar, in m/s.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

Tire Information

Manufacturer — Tire manufacturer

string scalar

Tire manufacturer, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

TireLine — Tire line

string scalar

Tire line, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

TireCategory — Tire category

string scalar

Tire category, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

ConstructionNumber — Tire construction number

string scalar

Tire construction number, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

SerialNumber — Tire serial number

nonnegative scalar

Tire serial number, specified as a nonnegative scalar, unitless.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

TireSize — Tire size

string scalar

Tire size, specified as a string scalar.

Example: TireSize="275/65R18"

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

SectionWidth — Section width

nonnegative scalar

Section width, specified as a nonnegative scalar, in mm.

Example: SectionWidth=275

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

AspectRatio — Aspect ratio

nonnegative scalar

Aspect ratio, specified as a nonnegative scalar, in percent.

Example: AspectRatio=65

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

RimDiameter — Rim diameter

nonnegative scalar

Rim diameter, specified as a nonnegative scalar, in inches.

Example: RimDiameter=18

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

OverallDiameter — Overall diameter

nonnegative scalar

Overall diameter, specified as a nonnegative scalar, in m.

Example: OverallDiameter=0.815

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

LoadIndex — Load index

nonnegative scalar

Load index, specified as a nonnegative scalar, unitless.

Example: LoadIndex=116

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

SpeedSymbol — Speed symbol

string scalar

Speed symbol, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

StampedMaxLoad — Stamped max load

nonnegative scalar

Stamped max load, specified as a nonnegative scalar, in kg.

Example: StampedMaxLoad=1250

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

DOTcode — DOT tire identification number

string scalar

DOT tire identification number, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string

Protected Properties

Type — Model type

string scalar

Model type, specified as a string scalar.

Attributes:

GetAccess	protected
SetAccess	protected

Methods

Public Methods

tireModel.new	Create new tire model object
tireModel.builtin	Create new tire model object from built-in tire model
tireModel.import	Create new tire model object with parameters from external file or MATLAB structure
compute	Perform model computation on tire data channels
convert	Convert tire model to another tire model type
disp	Display tireModel object properties
diff	Create table of tire parameters that differ between two tire models
export	Write tire model parameter values to external file
fit	Optimize model parameter values to achieve model best fit to the input data
get	Import tire model parameter values from supported Simulink or Simscape tire blocks
plot	Plot response of tire models
set	Export tire model parameter values to supported Simulink or Simscape tire blocks
struct	Create structure from tire model
table	Create table from tire model

Version History

Introduced in R2023b

R2025a: New tireModel object property

Starting in R2025a, you can set the TireCategory property.