Description

Base class for a coil-spring or air-spring solid axle suspension.

The suspension subsystem is modeled with respect to a right-handed frame, with X pointing towards the front, Y to the left, and Z up (ISO standard). The suspension reference frame is assumed to be always aligned with that of the vehicle. When attached to a chassis, only an offset is provided.

All point locations are assumed to be given for the left half of the suspension and will be mirrored (reflecting the y coordinates) to construct the right side.

#include <ChSolidThreeLinkAxle.h>

Inheritance diagram for chrono::vehicle::ChSolidThreeLinkAxle:

[legend]

Collaboration diagram for chrono::vehicle::ChSolidThreeLinkAxle:

[legend]

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

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

virtual bool	IsSteerable () const final override
	Specify whether or not this suspension can be steered.

virtual bool	IsIndependent () const final override
	Specify whether or not this is an independent suspension.

virtual void	Initialize (std::shared_ptr< ChBodyAuxRef > chassis, const ChVector<> &location, std::shared_ptr< ChBody > tierod_body, int steering_index, double left_ang_vel=0, double right_ang_vel=0) override
	Initialize this suspension subsystem. More...

virtual void	AddVisualizationAssets (VisualizationType vis) override
	Add visualization assets for the suspension subsystem. More...

virtual void	RemoveVisualizationAssets () override
	Remove visualization assets for the suspension subsystem.

virtual double	GetMass () const override
	Get the total mass of the suspension subsystem.

virtual ChVector	GetCOMPos () const override
	Get the current global COM location of the suspension subsystem.

virtual double	GetTrack () override
	Get the wheel track for the suspension subsystem.

std::shared_ptr< ChLinkTSDA >	GetSpring (VehicleSide side) const
	Get a handle to the specified spring element.

std::shared_ptr< ChLinkTSDA >	GetShock (VehicleSide side) const
	Get a handle to the specified shock (damper) element.

virtual ChSuspension::Force	ReportSuspensionForce (VehicleSide side) const override
	Return current suspension forces (spring and shock) on the specified side.

double	GetSpringForce (VehicleSide side) const
	Get the force in the spring element.

double	GetSpringLength (VehicleSide side) const
	Get the current length of the spring element.

double	GetSpringDeformation (VehicleSide side) const
	Get the current deformation of the spring element.

double	GetShockForce (VehicleSide side) const
	Get the force in the shock (damper) element.

double	GetShockLength (VehicleSide side) const
	Get the current length of the shock (damper) element.

double	GetShockVelocity (VehicleSide side) const
	Get the current deformation velocity of the shock (damper) element.

virtual void	LogConstraintViolations (VehicleSide side) override
	Log current constraint violations.

void	LogHardpointLocations (const ChVector<> &ref, bool inches=false)

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

const ChVector &	GetLocation () const
	Get the location of the suspension subsystem relative to the chassis reference frame. More...

std::shared_ptr< ChBody >	GetSpindle (VehicleSide side) const
	Get a handle to the spindle body on the specified side.

std::shared_ptr< ChShaft >	GetAxle (VehicleSide side) const
	Get a handle to the axle shaft on the specified side.

std::shared_ptr< ChLinkLockRevolute >	GetRevolute (VehicleSide side) const
	Get a handle to the revolute joint on the specified side.

const ChVector &	GetSpindlePos (VehicleSide side) const
	Get the global location of the spindle on the specified side.

const ChQuaternion &	GetSpindleRot (VehicleSide side) const
	Get the orientation of the spindle body on the specified side. More...

const ChVector &	GetSpindleLinVel (VehicleSide side) const
	Get the linear velocity of the spindle body on the specified side. More...

ChVector	GetSpindleAngVel (VehicleSide side) const
	Get the angular velocity of the spindle body on the specified side. More...

double	GetAxleSpeed (VehicleSide side) const
	Get the angular speed of the axle on the specified side.

int	GetSteeringIndex () const
	Get the index of the associated steering index (-1 if non-steered).

void	Synchronize ()
	Synchronize this suspension subsystem. More...

void	ApplyAxleTorque (VehicleSide side, double torque)
	Apply the provided motor torque. More...

virtual double	getSpindleRadius () const =0
	Return the radius of the spindle body (visualization only).

virtual double	getSpindleWidth () const =0
	Return the width of the spindle body (visualization only).

virtual std::shared_ptr< ChBody >	GetLeftBody () const
	Specify the left body for a possible antirollbar subsystem. More...

virtual std::shared_ptr< ChBody >	GetRightBody () const
	Specify the right body for a possible antirollbar subsystem. More...

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.

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.

Protected Types
enum	PointId { SHOCK_A, SHOCK_C, SPRING_A, SPRING_C, SPINDLE, TRIANGLE_A, TRIANGLE_C, LINK_A, LINK_C, NUM_POINTS }
	Identifiers for the various hardpoints. More...

Protected Member Functions
virtual const ChVector	getLocation (PointId which)=0
	Return the location of the specified hardpoint. More...

virtual const ChVector	getAxleTubeCOM () const =0
	Return the center of mass of the axle tube.

virtual double	getAxleTubeMass () const =0
	Return the mass of the axle tube body.

virtual double	getSpindleMass () const =0
	Return the mass of the spindle body.

virtual double	getAxleTubeRadius () const =0
	Return the radius of the axle tube body (visualization only).

virtual const ChVector &	getAxleTubeInertia () const =0
	Return the moments of inertia of the axle tube body.

virtual const ChVector &	getSpindleInertia () const =0
	Return the moments of inertia of the spindle body.

virtual double	getAxleInertia () const =0
	Return the inertia of the axle shaft.

virtual double	getSpringRestLength () const =0
	Return the free (rest) length of the spring element.

virtual ChLinkTSDA::ForceFunctor *	getSpringForceFunctor () const =0
	Return the functor object for spring force.

virtual ChLinkTSDA::ForceFunctor *	getShockForceFunctor () const =0
	Return the functor object for shock force.

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

Protected Attributes
std::shared_ptr< ChBody >	m_axleTube
	handles to the axle tube body

std::shared_ptr< ChBody >	m_tierod
	handles to the tierod body

std::shared_ptr< ChLinkLockFree >	m_axleTubeGuide
	allows all translations and rotations

std::shared_ptr< ChLinkDistance >	m_triangle [2]
	longitudinal & lateral axle guides

std::shared_ptr< ChLinkDistance >	m_link [2]
	longitudinal axle guides

std::shared_ptr< ChLinkTSDA >	m_shock [2]
	handles to the spring links (L/R)

std::shared_ptr< ChLinkTSDA >	m_spring [2]
	handles to the shock links (L/R)

Protected Attributes inherited from chrono::vehicle::ChSuspension
ChVector	m_location
	location relative to chassis

int	m_steering_index
	index of associated steering mechanism

std::shared_ptr< ChBody >	m_spindle [2]
	handles to spindle bodies

std::shared_ptr< ChShaft >	m_axle [2]
	handles to axle shafts

std::shared_ptr< ChShaftsBody >	m_axle_to_spindle [2]
	handles to spindle-shaft connectors

std::shared_ptr< ChLinkLockRevolute >	m_revolute [2]
	handles to spindle revolute joints

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

Additional Inherited Members
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.

Member Enumeration Documentation

◆ PointId

enum chrono::vehicle::ChSolidThreeLinkAxle::PointId

protected

Identifiers for the various hardpoints.

Enumerator
SHOCK_A	shock, axle
SHOCK_C	shock, chassis
SPRING_A	spring, axle
SPRING_C	spring, chassis
SPINDLE	spindle location
TRIANGLE_A	triangle link location on the axle (single point y = 0)
TRIANGLE_C	triangle link locationon the chassis (two points)
LINK_A	longitudinal link location on the axle (two points)
LINK_C	longitudinal link location on the chassis (two points)

Constructor & Destructor Documentation

◆ ChSolidThreeLinkAxle()

chrono::vehicle::ChSolidThreeLinkAxle::ChSolidThreeLinkAxle ( const std::string & name )

Parameters

[in] name name of the subsystem

Member Function Documentation

◆ AddVisualizationAssets()

void chrono::vehicle::ChSolidThreeLinkAxle::AddVisualizationAssets ( VisualizationType vis )

overridevirtual

Add visualization assets for the suspension subsystem.

This default implementation uses primitives.

Reimplemented from chrono::vehicle::ChSuspension.

◆ getLocation()

virtual const ChVector chrono::vehicle::ChSolidThreeLinkAxle::getLocation ( PointId which )

protectedpure virtual

Return the location of the specified hardpoint.

The returned location must be expressed in the suspension reference frame.

◆ Initialize()

void chrono::vehicle::ChSolidThreeLinkAxle::Initialize	(	std::shared_ptr< ChBodyAuxRef >	chassis,
		const ChVector<> &	location,
		std::shared_ptr< ChBody >	tierod_body,
		int	steering_index,
		double	left_ang_vel = `0`,
		double	right_ang_vel = `0`
	)

overridevirtual

Initialize this suspension subsystem.

The suspension subsystem is initialized by attaching it to the specified chassis body at the specified location (with respect to and expressed in the reference frame of the chassis). It is assumed that the suspension reference frame is always aligned with the chassis reference frame.

Parameters

[in]	chassis	handle to the chassis body
[in]	location	location relative to the chassis frame
[in]	tierod_body	body to which tireods are connected
[in]	steering_index	index of the associated steering mechanism
[in]	left_ang_vel	initial angular velocity of left wheel
[in]	right_ang_vel	initial angular velocity of right wheel

Implements chrono::vehicle::ChSuspension.

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

/builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/suspension/ChSolidThreeLinkAxle.h
/builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/suspension/ChSolidThreeLinkAxle.cpp

Description

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members