chrono::vehicle::GenericWheeledSuspension Class Reference

Description

Generic wheeled vehicle suspension constructed with data from file.

#include <GenericWheeledSuspension.h>

Inheritance diagram for chrono::vehicle::GenericWheeledSuspension:
Collaboration diagram for chrono::vehicle::GenericWheeledSuspension:

Public Member Functions

 GenericWheeledSuspension (const std::string &filename)
 
 GenericWheeledSuspension (const rapidjson::Document &d)
 
virtual double getCamberAngle () const override
 Return the camber angle, in radians (default: 0).
 
virtual double getToeAngle () const override
 Return the toe angle, in radians (default: 0). More...
 
virtual double getSpindleMass () const override
 Return the mass of the spindle body.
 
virtual ChVector3d getSpindlePos () const override
 Return the location of the spindle body.
 
virtual double getSpindleRadius () const override
 Return the radius of the spindle body (visualization only).
 
virtual double getSpindleWidth () const override
 Return the width of the spindle body (visualization only).
 
virtual const ChVector3dgetSpindleInertia () const override
 Return the moments of inertia of the spindle body.
 
virtual double getAxleInertia () const override
 Return the inertia of the axle shaft.
 
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 BodyIdentifier getSpindleAttachmentBody () const override
 Specify the suspension body to which the spindle is attached.
 
virtual BodyIdentifier getAntirollBody () const override
 Specify the suspension body to which an antiroll bar subsystem can attach.
 
- Public Member Functions inherited from chrono::vehicle::ChGenericWheeledSuspension
virtual std::string GetTemplateName () const override
 Get the name of the vehicle subsystem template.
 
void DefineBody (const std::string &name, bool mirrored, const ChVector3d &pos, const ChQuaternion<> &rot, double mass, const ChVector3d &inertia_moments, const ChVector3d &inertia_products, std::shared_ptr< ChVehicleGeometry > geometry=nullptr)
 Add a body definition to the suspension subsystem. More...
 
void DefineJoint (const std::string &name, bool mirrored, ChVehicleJoint::Type type, BodyIdentifier body1, BodyIdentifier body2, const ChVector3d &pos, const ChQuaternion<> &rot, std::shared_ptr< ChVehicleBushingData > bdata=nullptr)
 Add a joint definition to the suspension subsystem. More...
 
void DefineDistanceConstraint (const std::string &name, bool mirrored, BodyIdentifier body1, BodyIdentifier body2, const ChVector3d &point1, const ChVector3d &point2)
 Add a distance constraint definition to the suspension subsystem. More...
 
void DefineTSDA (const std::string &name, bool mirrored, BodyIdentifier body1, BodyIdentifier body2, const ChVector3d &point1, const ChVector3d &point2, double rest_length, std::shared_ptr< ChLinkTSDA::ForceFunctor > force, std::shared_ptr< ChTSDAGeometry > geometry=nullptr)
 Add a TSDA to model a suspension spring or shock. More...
 
void DefineRSDA (const std::string &name, bool mirrored, BodyIdentifier body1, BodyIdentifier body2, const ChVector3d &pos, const ChVector3d &axis, double rest_angle, std::shared_ptr< ChLinkRSDA::TorqueFunctor > torque)
 Add an RSDA to model a suspension spring or shock. More...
 
virtual void Initialize (std::shared_ptr< ChChassis > chassis, std::shared_ptr< ChSubchassis > subchassis, std::shared_ptr< ChSteering > steering, const ChVector3d &location, 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 GetTrack () override
 Get the wheel track for the suspension subsystem.
 
virtual std::vector< ForceTSDA > ReportSuspensionForce (VehicleSide side) const override
 Return current suspension TSDA force information on the specified side.
 
virtual std::vector< ForceRSDA > ReportSuspensionTorque (VehicleSide side) const override
 Return current RSDA torque information on the specified side.
 
virtual void LogConstraintViolations (VehicleSide side) override
 Log current constraint violations.
 
virtual std::shared_ptr< ChBodyGetAntirollBody (VehicleSide side) const override
 Specify the suspension body on the specified side to attach a possible antirollbar subsystem. More...
 
- Public Member Functions inherited from chrono::vehicle::ChSuspension
const ChVector3dGetRelPosition () const
 Get the location of the suspension subsystem relative to the associated chassis reference frame. More...
 
std::shared_ptr< ChBodyGetSpindle (VehicleSide side) const
 Get a handle to the spindle body on the specified side.
 
std::shared_ptr< ChShaftGetAxle (VehicleSide side) const
 Get a handle to the axle shaft on the specified side.
 
std::shared_ptr< ChLinkLockRevoluteGetRevolute (VehicleSide side) const
 Get a handle to the revolute joint on the specified side.
 
const ChVector3dGetSpindlePos (VehicleSide side) const
 Get the global location of the spindle on the specified side.
 
ChQuaternion GetSpindleRot (VehicleSide side) const
 Get the orientation of the spindle body on the specified side. More...
 
const ChVector3dGetSpindleLinVel (VehicleSide side) const
 Get the linear velocity of the spindle body on the specified side. More...
 
ChVector3d 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.
 
virtual void Synchronize (double time)
 Synchronize this suspension subsystem.
 
virtual void Advance (double step)
 Advance the state of the suspension subsystem by the specified time step.
 
void ApplyAxleTorque (VehicleSide side, double torque)
 Apply the provided motor torque. More...
 
virtual std::shared_ptr< ChBodyGetBrakeBody (VehicleSide side) const
 Specify the body on the specified side for a possible connection to brake subsystem. More...
 
void ApplyParkingBrake (bool brake)
 Simple model of a parking brake.
 
- Public Member Functions inherited from chrono::vehicle::ChPart
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.
 
bool IsInitialized () const
 Return flag indicating whether or not the part is fully constructed.
 
double GetMass () const
 Get the subsystem mass. More...
 
const ChFrameGetCOMFrame () const
 Get the current subsystem COM frame (relative to and expressed in the subsystem's reference frame). More...
 
const ChMatrix33GetInertia () const
 Get the current subsystem inertia (relative to the subsystem COM frame). More...
 
const ChFrameGetTransform () const
 Get the current subsystem position relative to the global frame. More...
 
void SetVisualizationType (VisualizationType vis)
 Set the visualization mode for this subsystem.
 
virtual void SetOutput (bool state)
 Enable/disable output for this subsystem.
 
bool OutputEnabled () const
 Return the output state for this subsystem.
 

Additional Inherited Members

- Static Public Member Functions inherited from chrono::vehicle::ChPart
static ChMatrix33 TransformInertiaMatrix (const ChVector3d &moments, const ChVector3d &products, const ChMatrix33<> &vehicle_rot, const ChMatrix33<> &body_rot)
 Utility function for transforming inertia tensors between centroidal frames. More...
 
- Protected Member Functions inherited from chrono::vehicle::ChGenericWheeledSuspension
 ChGenericWheeledSuspension (const std::string &name)
 Protected constructor.
 
- Protected Member Functions inherited from chrono::vehicle::ChSuspension
 ChSuspension (const std::string &name)
 Construct a suspension subsystem with given name.
 
- Protected Member Functions inherited from chrono::vehicle::ChPart
 ChPart (const std::string &name)
 Construct a vehicle subsystem with the specified name.
 
void AddMass (double &mass)
 Add this subsystem's mass. More...
 
void AddInertiaProperties (ChVector3d &com, ChMatrix33<> &inertia)
 Add this subsystem's inertia properties. More...
 
void ExportBodyList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChBody >> bodies) const
 Export the list of bodies to the specified JSON document.
 
void ExportShaftList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaft >> shafts) const
 Export the list of shafts to the specified JSON document.
 
void ExportJointList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLink >> joints) const
 Export the list of joints to the specified JSON document.
 
void ExportCouplesList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaftsCouple >> couples) const
 Export the list of shaft couples to the specified JSON document.
 
void ExportMarkerList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChMarker >> markers) const
 Export the list of markers to the specified JSON document.
 
void ExportLinSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkTSDA >> springs) const
 Export the list of translational springs to the specified JSON document.
 
void ExportRotSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkRSDA >> springs) const
 Export the list of rotational springs to the specified JSON document.
 
void ExportBodyLoadList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLoadBodyBody >> loads) const
 Export the list of body-body loads to the specified JSON document.
 
- Static Protected Member Functions inherited from chrono::vehicle::ChPart
static void RemoveVisualizationAssets (std::shared_ptr< ChPhysicsItem > item)
 Erase all visual shapes from the visual model associated with the specified physics item (if any).
 
static void RemoveVisualizationAsset (std::shared_ptr< ChPhysicsItem > item, std::shared_ptr< ChVisualShape > shape)
 Erase the given shape from the visual model associated with the specified physics item (if any).
 
- Protected Attributes inherited from chrono::vehicle::ChSuspension
ChVector3d m_rel_loc
 location relative to chassis
 
std::shared_ptr< ChBodym_spindle [2]
 handles to spindle bodies
 
std::shared_ptr< ChShaftm_axle [2]
 handles to axle shafts
 
std::shared_ptr< ChShaftBodyRotationm_axle_to_spindle [2]
 handles to spindle-shaft connectors
 
std::shared_ptr< ChLinkLockRevolutem_revolute [2]
 handles to spindle revolute joints
 
- Protected Attributes inherited from chrono::vehicle::ChPart
std::string m_name
 subsystem name
 
bool m_initialized
 specifies whether ot not the part is fully constructed
 
bool m_output
 specifies whether or not output is generated for this subsystem
 
std::shared_ptr< ChPartm_parent
 parent subsystem (empty if parent is vehicle)
 
double m_mass
 subsystem mass
 
ChMatrix33 m_inertia
 inertia tensor (relative to subsystem COM)
 
ChFrame m_com
 COM frame (relative to subsystem reference frame)
 
ChFrame m_xform
 subsystem frame expressed in the global frame
 

Member Function Documentation

◆ getToeAngle()

virtual double chrono::vehicle::GenericWheeledSuspension::getToeAngle ( ) const
inlineoverridevirtual

Return the toe angle, in radians (default: 0).

A positive value indicates toe-in, a negative value indicates toe-out.

Reimplemented from chrono::vehicle::ChGenericWheeledSuspension.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/suspension/GenericWheeledSuspension.h
  • /builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/suspension/GenericWheeledSuspension.cpp