Description

Template for simple powertrain model based on speed-torque engine maps.

This model has no torque converter and can have either a manual or an automatic transmission. It accepts a single reverse gear and any number of forward gears. In automatic mode, gear shifting is done based on specified ideal shift points.

#include <ChSimpleMapPowertrain.h>

Inheritance diagram for chrono::vehicle::ChSimpleMapPowertrain:

[legend]

Collaboration diagram for chrono::vehicle::ChSimpleMapPowertrain:

[legend]

Public Member Functions
	ChSimpleMapPowertrain (const std::string &name)

virtual std::string	GetTemplateName () const override
	Get the name of the vehicle subsystem template.

virtual double	GetMotorSpeed () const override
	Return the current engine speed.

virtual double	GetMotorTorque () const override
	Return the current engine torque.

virtual double	GetTorqueConverterSlippage () const override
	Return the value of slippage in the torque converter. More...

virtual double	GetTorqueConverterInputTorque () const override
	Return the input torque to the torque converter. More...

virtual double	GetTorqueConverterOutputTorque () const override
	Return the output torque from the torque converter. More...

virtual int	GetCurrentTransmissionGear () const override
	Return the current transmission gear. More...

virtual double	GetOutputTorque () const override
	Return the output torque from the powertrain. More...

virtual void	SetDriveMode (ChPowertrain::DriveMode mode) override
	Use this function to set the mode of the transmission box.

void	EnableAutomaticTransmission (bool automatic)
	Enable/disable automatic transmission. More...

void	SetForwardGear (int igear)
	Set the current forward gear (1, 2, ...). More...

Public Member Functions inherited from chrono::vehicle::ChPowertrain
	ChPowertrain (const std::string &name)

DriveMode	GetDriveMode ()
	Return the current mode of the transmission.

Public Member Functions inherited from chrono::vehicle::ChPart
	ChPart (const std::string &name)
	Construct a vehicle subsystem with the specified name. More...

const std::string &	GetName () const
	Get the name identifier for this subsystem.

void	SetName (const std::string &name)
	Set the name identifier for this subsystem.

void	SetVisualizationType (VisualizationType vis)
	Set the visualization mode for this subsystem.

virtual void	AddVisualizationAssets (VisualizationType vis)
	Add visualization assets to this subsystem, for the specified visualization mode.

virtual void	RemoveVisualizationAssets ()
	Remove all visualization assets from this subsystem.

void	SetContactFrictionCoefficient (float friction_coefficient)
	Set coefficient of friction. More...

void	SetContactRestitutionCoefficient (float restitution_coefficient)
	Set coefficient of restitution. More...

void	SetContactMaterialProperties (float young_modulus, float poisson_ratio)
	Set contact material properties. More...

void	SetContactMaterialCoefficients (float kn, float gn, float kt, float gt)
	Set contact material coefficients. More...

float	GetCoefficientFriction () const
	Get coefficient of friction for contact material.

float	GetCoefficientRestitution () const
	Get coefficient of restitution for contact material.

float	GetYoungModulus () const
	Get Young's modulus of elasticity for contact material.

float	GetPoissonRatio () const
	Get Poisson ratio for contact material.

float	GetKn () const
	Get normal stiffness coefficient for contact material.

float	GetKt () const
	Get tangential stiffness coefficient for contact material.

float	GetGn () const
	Get normal viscous damping coefficient for contact material.

float	GetGt () const
	Get tangential viscous damping coefficient for contact material.

virtual void	SetOutput (bool state)
	Enable/disable output for this subsystem.

bool	OutputEnabled () const
	Return the output state for this subsystem.

virtual void	ExportComponentList (rapidjson::Document &jsonDocument) const
	Export this subsystem's component list to the specified JSON object. More...

virtual void	Output (ChVehicleOutput &database) const
	Output data for this subsystem's component list to the specified database.

Protected Member Functions
virtual double	GetMaxEngineSpeed ()=0
	Specify maximum engine speed.

virtual void	SetEngineTorqueMaps (ChFunction_Recorder &map0, ChFunction_Recorder &mapF)=0
	Set the engine speed-torque maps. More...

virtual void	SetGearRatios (std::vector< double > &fwd_gear_ratios, double &reverse_gear_ratio)=0
	Set the gears, i.e. More...

virtual void	SetShiftPoints (std::vector< std::pair< double, double >> &shift_bands)=0
	Set the ideal shift points for automatic gear shifting. More...

Protected Member Functions inherited from chrono::vehicle::ChPart
virtual void	Create (const rapidjson::Document &d)
	Create a vehicle subsystem from JSON data. More...

Additional Inherited Members
Public Types inherited from chrono::vehicle::ChPowertrain
enum	DriveMode { FORWARD, NEUTRAL, REVERSE }
	Driving modes. More...

Static Public Member Functions inherited from chrono::vehicle::ChPart
static ChMatrix33	TransformInertiaMatrix (const ChVector<> &moments, const ChVector<> &products, const ChMatrix33<> &vehicle_rot, const ChMatrix33<> &body_rot)
	Utility function for transforming inertia tensors between centroidal frames. More...

Static Protected Member Functions inherited from chrono::vehicle::ChPart
static void	ExportBodyList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChBody >> bodies)
	Export the list of bodies to the specified JSON document.

static void	ExportShaftList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaft >> shafts)
	Export the list of shafts to the specified JSON document.

static void	ExportJointList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLink >> joints)
	Export the list of joints to the specified JSON document.

static void	ExportCouplesList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaftsCouple >> couples)
	Export the list of shaft couples to the specified JSON document.

static void	ExportMarkerList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChMarker >> markers)
	Export the list of markers to the specified JSON document.

static void	ExportLinSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkTSDA >> springs)
	Export the list of translational springs to the specified JSON document.

static void	ExportRotSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkRotSpringCB >> springs)
	Export the list of rotational springs to the specified JSON document.

static void	ExportBodyLoadList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLoadBodyBody >> loads)
	Export the list of body-body loads to the specified JSON document.

Protected Attributes inherited from chrono::vehicle::ChPowertrain
DriveMode	m_drive_mode
	drive mode (neutral, forward, or reverse)

std::shared_ptr< ChDriveline >	m_driveline
	associated driveline subsystem

Protected Attributes inherited from chrono::vehicle::ChPart
std::string	m_name
	subsystem name

bool	m_output
	specifies whether or not output is generated for this subsystem

float	m_friction
	contact coefficient of friction

float	m_restitution
	contact coefficient of restitution

float	m_young_modulus
	contact material Young modulus

float	m_poisson_ratio
	contact material Poisson ratio

float	m_kn
	normal contact stiffness

float	m_gn
	normal contact damping

float	m_kt
	tangential contact stiffness

float	m_gt
	tangential contact damping

Member Function Documentation

◆ EnableAutomaticTransmission()

void chrono::vehicle::ChSimpleMapPowertrain::EnableAutomaticTransmission ( bool automatic )

Enable/disable automatic transmission.

If enabled, gear selection is based on the provided ideal shift points.

◆ GetCurrentTransmissionGear()

int chrono::vehicle::ChSimpleMapPowertrain::GetCurrentTransmissionGear ( ) const

overridevirtual

Return the current transmission gear.

Returns 0 if in REVERSE, or the current gear if in FORWARD mode.

Implements chrono::vehicle::ChPowertrain.

◆ GetOutputTorque()

virtual double chrono::vehicle::ChSimpleMapPowertrain::GetOutputTorque ( ) const

inlineoverridevirtual

Return the output torque from the powertrain.

This is the torque that is passed to a vehicle system, thus providing the interface between the powertrain and vehicle co-simulation modules.

Implements chrono::vehicle::ChPowertrain.

◆ GetTorqueConverterInputTorque()

virtual double chrono::vehicle::ChSimpleMapPowertrain::GetTorqueConverterInputTorque ( ) const

inlineoverridevirtual

Return the input torque to the torque converter.

This simplified model does not have a torque converter.

Implements chrono::vehicle::ChPowertrain.

◆ GetTorqueConverterOutputTorque()

virtual double chrono::vehicle::ChSimpleMapPowertrain::GetTorqueConverterOutputTorque ( ) const

inlineoverridevirtual

Return the output torque from the torque converter.

This simplified model does not have a torque converter.

Implements chrono::vehicle::ChPowertrain.

◆ GetTorqueConverterSlippage()

virtual double chrono::vehicle::ChSimpleMapPowertrain::GetTorqueConverterSlippage ( ) const

inlineoverridevirtual

Return the value of slippage in the torque converter.

This simplified model does not have a torque converter.

Implements chrono::vehicle::ChPowertrain.

◆ SetEngineTorqueMaps()

virtual void chrono::vehicle::ChSimpleMapPowertrain::SetEngineTorqueMaps	(	ChFunction_Recorder &	map0,
		ChFunction_Recorder &	mapF
	)

protectedpure virtual

Set the engine speed-torque maps.

A concrete class must add the speed-torque points to the provided maps, using the ChFunction_Recorder::AddPoint() function.

Parameters

[out]	map0	engine map at zero throttle
[out]	mapF	engine map at full throttle

Implemented in chrono::vehicle::SimpleMapPowertrain, chrono::vehicle::citybus::CityBus_SimpleMapPowertrain, chrono::vehicle::hmmwv::HMMWV_SimpleMapPowertrain, chrono::vehicle::man::MAN_5t_SimpleMapPowertrain, chrono::vehicle::sedan::Sedan_SimpleMapPowertrain, chrono::vehicle::uaz::UAZBUS_SimpleMapPowertrain, and chrono::vehicle::man::MAN_7t_SimpleMapPowertrain.

◆ SetForwardGear()

void chrono::vehicle::ChSimpleMapPowertrain::SetForwardGear ( int igear )

Set the current forward gear (1, 2, ...).

This function has no effect if the transmission is set to automatic or if currently not in FORWARD drive mode.

◆ SetGearRatios()

virtual void chrono::vehicle::ChSimpleMapPowertrain::SetGearRatios	(	std::vector< double > &	fwd_gear_ratios,
		double &	reverse_gear_ratio
	)

protectedpure virtual

Set the gears, i.e.

the transmission ratios of the various gears. A concrete class must populate the vector of forward gear ratios, ordered as 1st, 2nd, etc. and provide a value for the single reverse gear ratio.

Parameters

[out]	fwd_gear_ratios	list of forward gear ratios
[out]	reverse_gear_ratio	single reverse gear ratio

Implemented in chrono::vehicle::citybus::CityBus_SimpleMapPowertrain, chrono::vehicle::hmmwv::HMMWV_SimpleMapPowertrain, chrono::vehicle::man::MAN_5t_SimpleMapPowertrain, chrono::vehicle::sedan::Sedan_SimpleMapPowertrain, chrono::vehicle::uaz::UAZBUS_SimpleMapPowertrain, chrono::vehicle::man::MAN_7t_SimpleMapPowertrain, and chrono::vehicle::SimpleMapPowertrain.

◆ SetShiftPoints()

virtual void chrono::vehicle::ChSimpleMapPowertrain::SetShiftPoints ( std::vector< std::pair< double, double >> & shift_bands )

protectedpure virtual

Set the ideal shift points for automatic gear shifting.

For each forward gear, specify a pair (min, max) with the minimum and maximum engine speed for shifting (down and up, respectively).

Parameters

[out] shift_bands down-shift/up-shift points

Implemented in chrono::vehicle::citybus::CityBus_SimpleMapPowertrain, chrono::vehicle::hmmwv::HMMWV_SimpleMapPowertrain, chrono::vehicle::man::MAN_5t_SimpleMapPowertrain, chrono::vehicle::sedan::Sedan_SimpleMapPowertrain, chrono::vehicle::uaz::UAZBUS_SimpleMapPowertrain, chrono::vehicle::man::MAN_7t_SimpleMapPowertrain, and chrono::vehicle::SimpleMapPowertrain.

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

/builds/uwsbel/chrono/src/chrono_vehicle/powertrain/ChSimpleMapPowertrain.h
/builds/uwsbel/chrono/src/chrono_vehicle/powertrain/ChSimpleMapPowertrain.cpp

Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ EnableAutomaticTransmission()

◆ GetCurrentTransmissionGear()

◆ GetOutputTorque()

◆ GetTorqueConverterInputTorque()

◆ GetTorqueConverterOutputTorque()

◆ GetTorqueConverterSlippage()

◆ SetEngineTorqueMaps()

◆ SetForwardGear()

◆ SetGearRatios()

◆ SetShiftPoints()