Description

Base class for an engine subsystem.

#include <ChEngine.h>

Inheritance diagram for chrono::vehicle::ChEngine:
Collaboration diagram for chrono::vehicle::ChEngine:

Public Member Functions

virtual double GetMotorSpeed () const =0
 Return the current engine speed.
 
virtual double GetOutputMotorshaftTorque () const =0
 Return the output engine torque on the motorshaft. More...
 
virtual double GetChassisReactionTorque () const
 Return the reaction torque on the chassis body. More...
 
- 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.
 
virtual std::string GetTemplateName () const =0
 Get the name of the vehicle subsystem template.
 
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 AddVisualizationAssets (VisualizationType vis)
 Add visualization assets to this subsystem, for the specified visualization mode.
 
virtual void RemoveVisualizationAssets ()
 Remove all visualization assets from this subsystem.
 
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

 ChEngine (const std::string &name="")
 
virtual void InitializeInertiaProperties () override
 Initialize subsystem inertia properties. More...
 
virtual void UpdateInertiaProperties () override
 Update subsystem inertia properties. More...
 
virtual void Initialize (std::shared_ptr< ChChassis > chassis)
 Initialize this engine.
 
virtual void Synchronize (double time, const DriverInputs &driver_inputs, double motorshaft_speed)=0
 Update the engine system at the current time. More...
 
virtual void Advance (double step)
 Advance the state of the engine by the specified time step.
 
- 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...
 
virtual void Create (const rapidjson::Document &d)
 Create a vehicle subsystem from JSON data. 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.
 

Friends

class ChPowertrainAssembly
 

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...
 
- 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::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

◆ GetChassisReactionTorque()

virtual double chrono::vehicle::ChEngine::GetChassisReactionTorque ( ) const
inlinevirtual

Return the reaction torque on the chassis body.

A concrete model may incorporate a physical connection to the chassis and therefore calculate this reaction.

Reimplemented in chrono::vehicle::ChEngineShafts.

◆ GetOutputMotorshaftTorque()

virtual double chrono::vehicle::ChEngine::GetOutputMotorshaftTorque ( ) const
pure virtual

Return the output engine torque on the motorshaft.

This is the torque passed to a transmission subsystem.

Implemented in chrono::vehicle::ChEngineShafts, chrono::vehicle::ChEngineSimpleMap, and chrono::vehicle::ChEngineSimple.

◆ InitializeInertiaProperties()

void chrono::vehicle::ChEngine::InitializeInertiaProperties ( )
overrideprotectedvirtual

Initialize subsystem inertia properties.

Derived classes must override this function and set the subsystem mass (m_mass) and, if constant, the subsystem COM frame and its inertia tensor. This function is called during initialization of the vehicle system.

Implements chrono::vehicle::ChPart.

◆ Synchronize()

virtual void chrono::vehicle::ChEngine::Synchronize ( double  time,
const DriverInputs driver_inputs,
double  motorshaft_speed 
)
protectedpure virtual

Update the engine system at the current time.

The engine is provided the current driver throttle input, a value in the range [0,1]. The motorshaft speed represents the input to the engine from the transmision system. This default implementation sets the speed of the motorshaft.

Parameters
timecurrent time
driver_inputscurrent driver inputs
motorshaft_speedinput transmission speed

◆ UpdateInertiaProperties()

void chrono::vehicle::ChEngine::UpdateInertiaProperties ( )
overrideprotectedvirtual

Update subsystem inertia properties.

Derived classes must override this function and set the global subsystem transform (m_xform) and, unless constant, the subsystem COM frame (m_com) and its inertia tensor (m_inertia). Calculate the current inertia properties and global frame of this subsystem. This function is called every time the state of the vehicle system is advanced in time.

Implements chrono::vehicle::ChPart.


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