AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxDriveTrain::DryClutch Class Reference

Single disk plate clutch with dry friction. More...

#include <DryClutch.h>

+ Inheritance diagram for agxDriveTrain::DryClutch:

Public Member Functions

 DryClutch ()
 
agx::Real getDisengageTimeConstant () const
 
agx::Real getEngageTimeConstant () const
 
agx::Real getFraction () const
 
agx::Real getInputVelocity () const
 
agx::Real getMinRelativeSlip () const
 
agx::Real getOutputVelocity () const
 
agx::Real getSlip () const
 
agx::Real getTorque () const
 
agx::Real getTorqueCapacity () const
 
bool isAutoLock () const
 
bool isEngaged () const
 
bool isLocked () const
 Returns the lock status.
 
bool isManualMode () const
 
void setAutoLock (bool autoLock)
 In auto lock mode, the friction plates will lock when the slip is small enough in proportion to the velocity of the input shaft.
 
void setDisengageTimeConstant (agx::Real tau)
 Set the time constant for clutch disengagement.
 
void setEngage (bool engage)
 Puts the clutch pedal in assisted mode so it will fully engage or disengage in a time period determined by setTimeConstant below.
 
void setEngageTimeConstant (agx::Real tau)
 Set the time constant for the clutch engagement.
 
void setFraction (agx::Real fraction)
 
void setLock (bool setLock)
 Lock or unlock the friction plates.
 
void setManualMode (bool manual)
 When manual mode is true, user must control all aspects of the clutch engagement and disengagement.
 
void setMinRelativeSlip (agx::Real minRelativeSlip)
 In autolock mode, the friction plates will lock with the ratio of slip to input shaft velocity is less than this threshold.
 
void setTorqueCapacity (agx::Real capacity)
 This is the maximum torque that the friction plates can transfer: it will slip if this MinRelativeSlip is exceeded.
 
- Public Member Functions inherited from agxPowerLine::RotationalConnector
 RotationalConnector ()
 Create a connector between two rotational dimensions.
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxPowerLine::RotationalConnector)
 
virtual agx::RegularizationParameters::VariableType calculateComplianceAndDamping (const agx::Real timeStep, agx::Real &compliance, agx::Real &damping) override
 Calculate a compliance that will result in the wanted efficiency.
 
virtual PhysicalDimensionMultiBodyConstraintImplementation * createConstraint () override
 Create a gear constraint.
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxPowerLine::Connector
 Connector ()
 create a connector
 
virtual bool addNotification (agxSDK::Simulation *simulation) override
 
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxPowerLine::Connector)
 
virtual agx::RegularizationParameters::VariableType calculateComplianceAndDamping (const agx::Real, agx::Real &, agx::Real &)
 Calculate the compliance and damping according to the connector properties (efficiency, ratio, ..)
 
agx::Real calculateEfficiency () const
 calculate simulated efficiency
 
virtual agx::Real calculateViolation () const
 calculate violation for constraint
 
bool compareWithInputTypes (PhysicalDimensionRefVector &dimensions) const
 
bool compareWithOutputTypes (PhysicalDimensionRefVector &dimensions) const
 
bool connect (agxPowerLine::PhysicalDimension *dimension, agxPowerLine::Side connectorSide, agxPowerLine::Side dimensionSide)
 Connect on the physical dimension level only.
 
virtual bool connect (agxPowerLine::PhysicalDimension *inputDimension, agxPowerLine::Side inputSide, agxPowerLine::Side outputSide, agxPowerLine::PhysicalDimension *outputDimension)
 
virtual bool connect (agxPowerLine::Side mySide, agxPowerLine::Side unitSide, agxPowerLine::Unit *unit)
 
virtual bool connect (agxPowerLine::Unit *unit)
 Connect a unit to this Connector.
 
bool connectDimensions (Unit *unit, agxPowerLine::Side mySide, agxPowerLine::Side unitSide)
 
virtual agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation * createConstraint ()=0
 Create the constraint (implement this to create whatever constraint you need)
 
virtual bool disconnect ()
 
bool disconnect (agxPowerLine::PhysicalDimension *dimension, agxPowerLine::Side connectorSide, agxPowerLine::Side dimensionSide)
 
virtual bool disconnect (agxPowerLine::Unit *unit)
 Disconnect the given unit from this Connector.
 
agxPowerLine::Connection * findConnection (const agxPowerLine::Unit *unit, agxPowerLine::Side side)
 
const agxPowerLine::Connection * findConnection (const agxPowerLine::Unit *unit, agxPowerLine::Side side) const
 
agxPowerLine::Connection * findInputConnection (const agxPowerLine::Unit *unit)
 
const agxPowerLine::Connection * findInputConnection (const agxPowerLine::Unit *unit) const
 
agxPowerLine::Connection * findOutputConnection (const agxPowerLine::Unit *unit)
 
const agxPowerLine::Connection * findOutputConnection (const agxPowerLine::Unit *unit) const
 
const agxPowerLine::ConnectionRefVector & getConnections (agxPowerLine::Side side) const
 
agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation * getConstraint () const
 
agx::Real getDamping () const
 
agxPowerLine::ElementaryPhysicalDimensionConstraint * getElementaryConstraint () const
 
bool getIgnoreForStoreRestoreStream () const
 
agxPowerLine::Connection * getInputConnection (size_t index)
 return a specific input connection
 
const agxPowerLine::Connection * getInputConnection (size_t index) const
 return a specific output connection
 
agxPowerLine::ConnectionRefVector & getInputConnections ()
 return vector to all input connections from this connector
 
const agxPowerLine::ConnectionRefVector & getInputConnections () const
 return vector to all input connections from this connector
 
PhysicalDimension * getInputDimension (const PhysicalDimension::Type dimensionType) const
 
const DimensionTypeVector & getInputTypes () const
 
bool getInputUnits (UnitConstPtrSetVector &units, const bool startFromCleanUnitSet=true) const
 
bool getInputUnits (UnitPtrSetVector &units, const bool startFromCleanUnitSet=true)
 
int getNumConnections () const
 
int getNumConnections (agxPowerLine::Side side) const
 
int getNumFreeConnections () const
 
int getNumFreeConnections (agxPowerLine::Side side) const
 
int getNumFreeInputConnections () const
 
int getNumFreeOutputConnections () const
 
int getNumInputConnections () const
 
int getNumOutputConnections () const
 
int getNumPossibleInputConnections () const
 
int getNumPossibleOutputConnections () const
 
agxPowerLine::Connection * getOutputConnection (size_t index)
 return a specific input connection
 
const agxPowerLine::Connection * getOutputConnection (size_t index) const
 return a specific output connection
 
agxPowerLine::ConnectionRefVector & getOutputConnections ()
 return vector to all output connections from this connector
 
const agxPowerLine::ConnectionRefVector & getOutputConnections () const
 return vector to all output connections from this connector
 
PhysicalDimension * getOutputDimension (const PhysicalDimension::Type dimensionType) const
 
const DimensionTypeVector & getOutputTypes () const
 
bool getOutputUnits (UnitConstPtrSetVector &units, const bool startFromCleanUnitSet=true) const
 
bool getOutputUnits (UnitPtrSetVector &units, const bool startFromCleanUnitSet=true)
 
agx::Real getPowerIn () const
 
agxPowerLine::PowerLine * getPowerLine () const
 
agx::Real getPowerOut () const
 
agx::Real getRatio () const
 
virtual agx::Real getRatio (agx::Real x) const
 
agx::Real getRatioDerivative () const
 
virtual agx::Real getRatioDerivative (agx::Real x) const
 
virtual agxPowerLine::Side getSide (const agxPowerLine::Unit *unit) const
 
const DimensionTypeVector & getTypes (agxPowerLine::Side side) const
 
bool getUnits (UnitConstPtrSetVector &units, agxPowerLine::Side side, const bool startFromCleanUnitSet=true) const
 
bool getUnits (UnitConstPtrSetVector &units, const bool startFromCleanUnitSet=true) const
 
bool getUnits (UnitPtrSetVector &units, agxPowerLine::Side side, const bool startFromCleanUnitSet=true)
 
bool getUnits (UnitPtrSetVector &units, const bool startFromCleanUnitSet=true)
 
virtual agx::Real getViolation () const
 Returns the constraint violation for connectors with holonomic constraints.
 
bool hasFreeConnection () const
 
bool hasFreeConnection (agxPowerLine::Side side) const
 
bool hasFreeInputConnection () const
 
bool hasFreeOutputConnection () const
 
bool hasInputConnection (Connection *connection)
 Find out if the connection belongs to this connector.
 
bool hasOutputConnection (Connection *connection)
 
virtual void initConstraint ()
 
bool isConstraintValid () const
 
virtual bool isInput (const agxPowerLine::PhysicalDimension *dimension) const
 Determine if the given dimension is part of any of the input connections of this Connector.
 
virtual bool isOutput (Connection *connection) const
 Find out if a connection is output from this connector.
 
virtual bool isOutput (const agxPowerLine::PhysicalDimension *dimension) const
 Find out if the given dimension is part of any of the output connections.
 
virtual bool postRestore (agxStream::StorageStream &str)
 
virtual bool postStore (agxStream::StorageStream &str) const
 Set values of constraints.
 
virtual bool removeNotification (agxUtil::ConstraintHolder *holder, agxSDK::Simulation *simulation) override
 remove connector and constraint from simulation
 
virtual void restore (agxStream::InputArchive &in) override
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
void setConstraint (agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation *constraint)
 set the constraint that represents this connector in the solver.
 
void setDamping (agx::Real damping)
 Set the damping of the constraint.
 
void setIgnoreForStoreRestoreStream (bool ignore)
 
void setNumPossibleInputConnections (int num)
 Define number of input dimensions the constraint should handle.
 
void setNumPossibleOutputConnections (int num)
 Define number of output dimensions the constraint should handle.
 
void setPowerLine (agxPowerLine::PowerLine *powerLine)
 
virtual void store (agxStream::OutputArchive &out) const override
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data for this segment into stream.
 
virtual bool vetoConnect (agxPowerLine::Unit *unit) const
 
- Public Member Functions inherited from agxPowerLine::SubGraph
 SubGraph ()
 
virtual bool addNotification (agxSDK::Simulation *simulation)=0
 
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxPowerLine::SubGraph)
 
virtual void getConnectorsRecursive (ConnectorPtrVector &connectors)
 Fill the given vector with the Connectors that are held by this SubGraph.
 
Connector * getEnclosingConnector ()
 
const Connector * getEnclosingConnector () const
 
SubGraph * getEnclosingGraph ()
 
const SubGraph * getEnclosingGraph () const
 
Unit * getEnclosingUnit ()
 
const Unit * getEnclosingUnit () const
 
const agxPowerLine::ConnectorRefVector & getInternalConnectors () const
 
const agxPowerLine::UnitRefVector & getInternalUnits () const
 
const agx::Name & getName () const
 
SubGraph * getRootEnclosingGraph ()
 
const SubGraph * getRootEnclosingGraph () const
 
virtual void getUnitsRecursive (UnitPtrVector &units)
 Fill the given vector with the Units that are held by this SubGraph.
 
bool isEnclosedWithin (const SubGraph *component) const
 
virtual bool postUpdate (agx::Real timeStep)
 
virtual void prepareForRestore ()
 
virtual void prepareForStore ()
 
virtual bool preUpdate (agx::Real timeStep)
 
virtual bool removeNotification (agxUtil::ConstraintHolder *holder, agxSDK::Simulation *simulation)=0
 
virtual void restore (agxStream::InputArchive &in) override
 
virtual bool restore (agxStream::StorageStream &str)
 Restores internal data from stream.
 
void setName (const agx::Name &name)
 Set the name of this power line component.
 
void spreadPowerLineToGraph ()
 
virtual void store (agxStream::OutputArchive &out) const override
 
virtual bool store (agxStream::StorageStream &str) const
 Stores internal data into stream.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Protected Member Functions

virtual ~DryClutch ()
 
bool addNotification (agxSDK::Simulation *simulation) override
 
agx::RegularizationParameters::VariableType calculateComplianceAndDamping (const agx::Real timeStep, agx::Real &compliance, agx::Real &damping) override
 Calculate a compliance that will result in the wanted efficiency.
 
void calculateTorqueCapacity (agx::Real maxForce, agx::Real mu, agx::Real radii[2])
 Calculate the torque capacity based on the geometric and physical parameters of the friction plates.
 
virtual agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation * createConstraint () override
 Create a gear constraint.
 
bool postRestore (agxStream::StorageStream &str) override
 
bool postStore (agxStream::StorageStream &str) const override
 Set values of constraints.
 
bool preUpdate (agx::Real timeStep) override
 
- Protected Member Functions inherited from agxPowerLine::RotationalConnector
virtual ~RotationalConnector ()
 
- Protected Member Functions inherited from agxPowerLine::Connector
virtual ~Connector ()
 
virtual bool connect (agxPowerLine::Unit *inputUnit, agxPowerLine::Side inputUnitSide, agxPowerLine::Side outputUnitSide, agxPowerLine::Unit *outputUnit)
 
bool getUnits (UnitConstPtrSetVector &units, const ConnectionRefVector &connections, const bool startFromCleanUnitSet=true) const
 
bool getUnits (UnitPtrSetVector &units, ConnectionRefVector &connections, const bool startFromCleanUnitSet=true)
 
bool hasNonValidInputConnection () const
 
bool hasNonValidOutputConnection () const
 
void setRatio (agx::Real ratio)
 set/get the ratio (scaling of load through the constraint).
 
void setRatioDerivative (agx::Real ratioDerivative)
 
void uninitialize ()
 
- Protected Member Functions inherited from agxPowerLine::SubGraph
virtual ~SubGraph ()
 
void addInternalConnector (agxPowerLine::Connector *connector)
 
void addInternalUnit (agxPowerLine::Unit *unit)
 
void removeInternalConnector (agxPowerLine::Connector *connector)
 
void removeInternalUnit (agxPowerLine::Unit *unit)
 
agx::Bool replaceInternalUnit (agxPowerLine::Unit *oldUnit, agxPowerLine::Unit *newUnit)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 

Protected Attributes

agx::Real m_disengageTimeConstant
 
agx::Real m_engageTimeConstant
 
agx::Real m_fraction
 
bool m_isAutoLock
 
bool m_isEngaged
 
bool m_isLocked
 
bool m_isManual
 
agx::Real m_minRelativeSlip
 
agx::Real m_torqueCapacity
 
- Protected Attributes inherited from agxPowerLine::Connector
PhysicalDimensionMultiBodyConstraintImplementation * m_constraint
 
agx::Real m_damping
 
bool m_ignoreMeForStoreRestoreStream
 
ConnectionRefVector m_inputConnections
 
DimensionTypeVector m_inputTypes
 
int m_numPossibleInputs
 
int m_numPossibleOutputs
 
ConnectionRefVector m_outputConnections
 
DimensionTypeVector m_outputTypes
 
agx::Real m_ratio
 
agx::Real m_ratioDerivative
 
- Protected Attributes inherited from agxPowerLine::SubGraph
SubGraphObserver m_enclosingGraph
 
ConnectorRefVector m_internalConnectors
 
UnitRefVector m_internalUnits
 
agx::Name m_name
 
PowerLine * m_powerLine
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from agxPowerLine::RotationalConnector
static agxStream::Serializable * create (agxStream::InputArchive &)
 
- Static Public Member Functions inherited from agxPowerLine::Connector
static PhysicalDimension * getDimension (const ConnectionRefVector &connections, const PhysicalDimension::Type dimensionType)
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 

Detailed Description

Single disk plate clutch with dry friction.

Input and output shafts are connected to plates with rough surfaces. A spring loaded mechanism increases the normal force between the plates between a minimum and maximum, giving rise to the concept of torque capacity. When the plates are at maximum distance from each other, no force is transmitted. When they are at zero distance, maximum pressure is applied.

Together with Coulomb friction, this keeps the plates rotating at nearly the same angular velocity untill the stick-slip transition is reached, alternately, when the torque required to move the output shaft at the same velocity as the input shaft reaches the torque capacity. This happens when the load on the output shaft is too difficult to move. If the two disks move relative to each other, this is called slipping so one can read the slip velocity at any time.

The "opening fraction" here represents the value of the torque capacity in proportion to the maximum capacity, i.e., when the plates are fully closed, i.e., maximum normal force is achieved. As for most clutches, this model includes a "locked" mode in which a clamp is activated to prevent any slip. This stays "ON" until the clutch is disengaged, or if the output shaft starts to move faster but in the same direction as the input shaft, as in the case of dynamic breaking.

This model has two modes, namely, manual and automatic. In the manual mode, the user is responsible to adjust the opening fraction, or set the lock mechanism directly. This can be done using a control algorithm and an event listener. For the automatic mode, a time constant determines how long it takes to go from fully open to fully engaged. The function "engage" determines whether we are ramping up or down. Setting auto lock mode activates logic to activate or deactivate the lock according to simple logic. If the slip velocity is small in proportion of the input shaft velocity, the lock is activated. If either "engage(false)" function is called or the torque between the places is negative – dynamic braking – then the lock is deactivated.

The maximum available torque before slipping for a given opening fraction \(f\) is ‘ \(fT_c\)’ where \(T_c\) is the torque capacity defined by

\[ T_c = 2\frac{2}{3}\mu\frac{r_2^3-r_1^3}{r_2^2-r_1^2}F \]

where \(r_i\) are the outer and inner radii. This defaults to a ‘reasonable’ number corresponding to a passenger car, namely, around 40 Nm

Automatic engagement makes the fraction increase linearly from the time the "engage(true)" function is called, or decreases linearly from the time the "engage(false)" is called.

We assume that the pressure plate is a linear spring so that $F$ is directly proportional to it's position.

Definition at line 80 of file DryClutch.h.

Constructor & Destructor Documentation

◆ DryClutch()

agxDriveTrain::DryClutch::DryClutch ( )

◆ ~DryClutch()

virtual agxDriveTrain::DryClutch::~DryClutch ( )
protectedvirtual

Member Function Documentation

◆ addNotification()

bool agxDriveTrain::DryClutch::addNotification ( agxSDK::Simulation *  simulation)
overrideprotectedvirtual

Reimplemented from agxPowerLine::Connector.

◆ calculateComplianceAndDamping()

agx::RegularizationParameters::VariableType agxDriveTrain::DryClutch::calculateComplianceAndDamping ( const agx::Real  timeStep,
agx::Real &  compliance,
agx::Real &  damping 
)
overrideprotectedvirtual

Calculate a compliance that will result in the wanted efficiency.

Reimplemented from agxPowerLine::RotationalConnector.

◆ calculateTorqueCapacity()

void agxDriveTrain::DryClutch::calculateTorqueCapacity ( agx::Real  maxForce,
agx::Real  mu,
agx::Real  radii[2] 
)
protected

Calculate the torque capacity based on the geometric and physical parameters of the friction plates.

Note
This will overwrite torque capacity set via setTorqueCapacity() method. The users are referred to the reference (Shaver R. Manual transmission clutch systems. Warrendale, Pennsylvania: SAE International, 1997.) for more information of the clutch parameters.
Parameters
maxForce- the maximum normal force exerted onto the frictional discs.
mu- the Coulomb friction coefficient.
radii- a 2D vector of the inner and outer radii of the frictional discs.

◆ createConstraint()

virtual agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation * agxDriveTrain::DryClutch::createConstraint ( )
overrideprotectedvirtual

Create a gear constraint.

Reimplemented from agxPowerLine::RotationalConnector.

◆ getDisengageTimeConstant()

agx::Real agxDriveTrain::DryClutch::getDisengageTimeConstant ( ) const
Returns
- Returns the time constant of the clutch pedal for disengaging.

◆ getEngageTimeConstant()

agx::Real agxDriveTrain::DryClutch::getEngageTimeConstant ( ) const
Returns
- Returns the time constant of the clutch pedal for engaging.

◆ getFraction()

agx::Real agxDriveTrain::DryClutch::getFraction ( ) const
Returns
- Returns the fraction of the clutch pedal opening (fraction of maximum normal force betwen the friction plates).

◆ getInputVelocity()

agx::Real agxDriveTrain::DryClutch::getInputVelocity ( ) const
Returns
- Angular velocity of input shaft.

◆ getMinRelativeSlip()

agx::Real agxDriveTrain::DryClutch::getMinRelativeSlip ( ) const
Returns
- Minimum relative velocity for lock.

◆ getOutputVelocity()

agx::Real agxDriveTrain::DryClutch::getOutputVelocity ( ) const
Returns
- Angular velocity of output shaft.

◆ getSlip()

agx::Real agxDriveTrain::DryClutch::getSlip ( ) const
Returns
- Relative velocity inbetween the friction plates.

◆ getTorque()

agx::Real agxDriveTrain::DryClutch::getTorque ( ) const
Returns
- Torque transferred between the friction plates.

◆ getTorqueCapacity()

agx::Real agxDriveTrain::DryClutch::getTorqueCapacity ( ) const
Returns
- Returns the torque capacity of the friction plates.

◆ isAutoLock()

bool agxDriveTrain::DryClutch::isAutoLock ( ) const
Returns
- State of auto lock.

◆ isEngaged()

bool agxDriveTrain::DryClutch::isEngaged ( ) const
Returns
- Returns whether the clutch is engaged or not.

◆ isLocked()

bool agxDriveTrain::DryClutch::isLocked ( ) const

Returns the lock status.

◆ isManualMode()

bool agxDriveTrain::DryClutch::isManualMode ( ) const
Returns
- Returns true in manual mode, false otherwise.

◆ postRestore()

bool agxDriveTrain::DryClutch::postRestore ( agxStream::StorageStream &  str)
overrideprotectedvirtual

Reimplemented from agxPowerLine::Connector.

◆ postStore()

bool agxDriveTrain::DryClutch::postStore ( agxStream::StorageStream &  str) const
overrideprotectedvirtual

Set values of constraints.

Must be called after the constraints are created.

Reimplemented from agxPowerLine::Connector.

◆ preUpdate()

bool agxDriveTrain::DryClutch::preUpdate ( agx::Real  timeStep)
overrideprotectedvirtual

Reimplemented from agxPowerLine::SubGraph.

◆ setAutoLock()

void agxDriveTrain::DryClutch::setAutoLock ( bool  autoLock)

In auto lock mode, the friction plates will lock when the slip is small enough in proportion to the velocity of the input shaft.

Parameters
autoLock- true or false to enable or disable autoLock, respectively (Default: false).

◆ setDisengageTimeConstant()

void agxDriveTrain::DryClutch::setDisengageTimeConstant ( agx::Real  tau)

Set the time constant for clutch disengagement.

Disengagement is linear and proceeds by a fraction of +/- step/tau per step. The default time constant is in seconds.

Parameters
tau- the time constant. The unit of tau is the same as the unit of time step size defined by the user (Default: 1.0).

◆ setEngage()

void agxDriveTrain::DryClutch::setEngage ( bool  engage)

Puts the clutch pedal in assisted mode so it will fully engage or disengage in a time period determined by setTimeConstant below.

Using engage(true) will turn manual mode to false as per the rule: respect the users's intention.

Parameters
engage- true to engage, false to disengage from current fraction (Default: false).

◆ setEngageTimeConstant()

void agxDriveTrain::DryClutch::setEngageTimeConstant ( agx::Real  tau)

Set the time constant for the clutch engagement.

Engagement is linear and proceeds by a fraction of +/- step/tau per step. The default time constant is in seconds.

Parameters
tau- the time constant. The unit of tau is the same as the unit of time step size defined by the user (Default: 2.5).

◆ setFraction()

void agxDriveTrain::DryClutch::setFraction ( agx::Real  fraction)
Parameters
fraction- Set the fraction of the clutch pedal opening in range [0,1] (Default: 0.0).

◆ setLock()

void agxDriveTrain::DryClutch::setLock ( bool  setLock)

Lock or unlock the friction plates.

In locked mode, the two plates are fixed rigidly together.

Parameters
setLock- desired state (Default: false).

◆ setManualMode()

void agxDriveTrain::DryClutch::setManualMode ( bool  manual)

When manual mode is true, user must control all aspects of the clutch engagement and disengagement.

Using the engage method will turn this flag to false.

Parameters
manual- Set or unset manual mode (Default: false).

◆ setMinRelativeSlip()

void agxDriveTrain::DryClutch::setMinRelativeSlip ( agx::Real  minRelativeSlip)

In autolock mode, the friction plates will lock with the ratio of slip to input shaft velocity is less than this threshold.

Parameters
minRelativeSlip- the threshold of the minimum slip (Default: 1e-5).

◆ setTorqueCapacity()

void agxDriveTrain::DryClutch::setTorqueCapacity ( agx::Real  capacity)

This is the maximum torque that the friction plates can transfer: it will slip if this MinRelativeSlip is exceeded.

Set the torque capacity directly here, or specify the geometrical and physical parameters of the friction plates, allowing the program to automatically calculate the torque capacity (Default: 2000).

Member Data Documentation

◆ m_disengageTimeConstant

agx::Real agxDriveTrain::DryClutch::m_disengageTimeConstant
protected

Definition at line 265 of file DryClutch.h.

◆ m_engageTimeConstant

agx::Real agxDriveTrain::DryClutch::m_engageTimeConstant
protected

Definition at line 264 of file DryClutch.h.

◆ m_fraction

agx::Real agxDriveTrain::DryClutch::m_fraction
protected

Definition at line 267 of file DryClutch.h.

◆ m_isAutoLock

bool agxDriveTrain::DryClutch::m_isAutoLock
protected

Definition at line 262 of file DryClutch.h.

◆ m_isEngaged

bool agxDriveTrain::DryClutch::m_isEngaged
protected

Definition at line 261 of file DryClutch.h.

◆ m_isLocked

bool agxDriveTrain::DryClutch::m_isLocked
protected

Definition at line 268 of file DryClutch.h.

◆ m_isManual

bool agxDriveTrain::DryClutch::m_isManual
protected

Definition at line 263 of file DryClutch.h.

◆ m_minRelativeSlip

agx::Real agxDriveTrain::DryClutch::m_minRelativeSlip
protected

Definition at line 266 of file DryClutch.h.

◆ m_torqueCapacity

agx::Real agxDriveTrain::DryClutch::m_torqueCapacity
protected

Definition at line 260 of file DryClutch.h.


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