AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxTerrain::TerrainWheelSettings Class Reference

Container for model-level configuration parameters. More...

#include <TerrainWheelSettings.h>

+ Inheritance diagram for agxTerrain::TerrainWheelSettings:

Public Types

enum  DebugOption : agx::UInt32 {
  PRINT_GENERAL_INFO = 1 << 0 , RENDER_REGRESSION_PLANES = 1 << 1 , PRINT_SIMULATION_STAGES = 1 << 2 , PRINT_CONTACT_EVENT_INFO = 1 << 3 ,
  PRINT_BOUNDS_INFO = 1 << 4
}
 Debug options for info prints and additional render options. More...
 
enum class  PressureSinkageModel { BEKKER = 0 , REECE = 1 }
 

Public Member Functions

 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxTerrain::TerrainWheelSettings)
 
agx::Real getAngularIntegrationStep () const
 Get the angular integration step size.
 
bool getDebugOption (DebugOption option) const
 Check whether a specific debug option is enabled.
 
bool getEnableComputeMaximumNormalStressAngleFromFrontAngle () const
 
bool getEnableComputeRearAngleFromFrontAngle () const
 
bool getEnableDebugBoundsInfo () const
 Check whether bounds debug printing is enabled.
 
bool getEnableDebugContactEventInfo () const
 Check whether contact event debug printing is enabled.
 
bool getEnableDebugGeneralInfo () const
 Check whether general debug information printing is enabled.
 
bool getEnableDebugRegressionPlanes () const
 Check whether debug regression plane rendering is enabled.
 
bool getEnableDebugSimulationStages () const
 Check whether simulation stage debug printing is enabled.
 
PressureSinkageModel getPressureSinkageModel () const
 Get the currently selected pressure-sinkage model.
 
agx::Real getRearAndFrontAngleMaxMagnitude () const
 Get the maximum allowed magnitude for the rear and front contact angles.
 
agx::Real getRollingModeOmegaYThreshold () const
 Return the wheel axle angular velocity magnitude threshold used to suppress rolling-mode classification.
 
agx::Real getRollingModeVxAngularEquivalentThreshold () const
 Return the longitudinal velocity threshold expressed as an angular-equivalent velocity used for rolling-mode classification.
 
agx::Real getSlipAngleFallbackValue () const
 Return the slip angle fallback value when both the vX and vY magnitudes are below their thresholds.
 
agx::Real getSlipAngleMaxMagnitude () const
 Return the maximum allowed slip angle magnitude.
 
agx::Real getSlipAngleVxAngularEquivalentThreshold () const
 Return the longitudinal velocity angular equivalent threshold used by the slip-angle computation.
 
agx::Real getSlipAngleVyAngularEquivalentThreshold () const
 Return the lateral velocity dead-zone angular equivalent threshold used by the slip-angle computation.
 
agx::Real getSlipRatioFallbackValue () const
 Return the slip ratio fallback value when the magnitudes of both the angular equivalent of vX and omegaY are below their thresholds.
 
agx::Real getSlipRatioMaxMagnitude () const
 Return the maximum allowed magnitude of the computed slip ratio.
 
agx::Real getSlipRatioOmegaYThreshold () const
 Return the wheel axle angular velocity magnitude threshold used to suppress slip-ratio computation.
 
agx::Real getSlipRatioSmoothingAngularSpeed () const
 Return the minimum velocity scale used to stabilize slip-ratio computation.
 
agx::Real getSlipRatioVxAngularEquivalentThreshold () const
 Return the longitudinal velocity threshold expressed as an angular-equivalent velocity used for slip-ratio computations.
 
void setAngularIntegrationStep (agx::Real angularIntegrationStep)
 Set the angular integration step size used by the TerrainWheel model.
 
void setDebugOption (DebugOption option, bool enable)
 Enable or disable a specific debug option.
 
void setEnableComputeMaximumNormalStressAngleFromFrontAngle (bool enable)
 Enable or disable computation of the maximum normal stress angle from the front contact angle.
 
void setEnableComputeRearAngleFromFrontAngle (bool enable)
 Enable or disable computation of the rear contact angle from the front contact angle.
 
void setEnableDebugBoundsInfo (bool enable)
 Enable or disable bounds info debug prints.
 
void setEnableDebugContactEventInfo (bool enable)
 Enable or disable contact event info debug prints.
 
void setEnableDebugGeneralInfo (bool enable)
 Enable or disable general debug prints.
 
void setEnableDebugRegressionPlanes (bool enable)
 Enable or disable debug rendering of regression planes.
 
void setEnableDebugSimulationStages (bool enable)
 Enable or disable simulation stage debug prints.
 
void setPressureSinkageModel (PressureSinkageModel pressureSinkageModel)
 Set the pressure-sinkage model used by the TerrainWheel model.
 
void setRearAndFrontAngleMaxMagnitude (agx::Real maxMagnitude)
 Set the maximum allowed magnitude for the rear and front contact angles.
 
void setRollingModeOmegaYThreshold (agx::Real omegaYThreshold)
 Set the threshold for the wheel axle angular velocity magnitude used to suppress rolling-mode classification from noisy low-speed kinematics.
 
void setRollingModeVxAngularEquivalentThreshold (agx::Real vXAngEquivThreshold)
 Set the threshold for the longitudinal wheel velocity expressed as an angular-equivalent velocity used to suppress rolling-mode classification from noisy low-speed kinematics.
 
void setSlipAngleFallbackValue (agx::Real fallbackValue)
 Set the fallback slip angle value when both vX and vY magnitudes are below their thresholds.
 
void setSlipAngleMaxMagnitude (agx::Real maxMagnitude)
 Set the maximum allowed slip-angle magnitude.
 
void setSlipAngleVxAngularEquivalentThreshold (agx::Real vXAngEquivThreshold)
 Set the longitudinal velocity angular equivalent threshold used by the slip-angle computation.
 
void setSlipAngleVyAngularEquivalentThreshold (agx::Real vYAngEquivThreshold)
 Set the lateral velocity dead-zone angular equivalent threshold used by the slip-angle computation.
 
void setSlipRatioFallbackValue (agx::Real fallbackValue)
 Set the fallback slip ratio value when both the vX and omegaY magnitudes are below their respective thresholds.
 
void setSlipRatioMaxMagnitude (agx::Real maxMagnitude)
 Set the maximum allowed magnitude of the computed slip ratio.
 
void setSlipRatioOmegaYThreshold (agx::Real omegaYThreshold)
 Set the threshold for the wheel axle axis angular velocity magnitude used to suppress slip-ratio computations.
 
void setSlipRatioSmoothingAngularSpeed (agx::Real smoothingAngularSpeed)
 Set the minimum velocity scale used to smooth slip-ratio computations.
 
void setSlipRatioVxAngularEquivalentThreshold (agx::Real vXAngEquivThreshold)
 Set the threshold for the longitudinal wheel velocity expressed as an angular-equivalent velocity used to suppress slip-ratio computations.
 
- 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.
 

Static Public Member Functions

static agxStream::Serializable * create (agxStream::InputArchive &)
 
- 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.
 

Protected Attributes

agx::Real m_angularIntegrationStep {0.001}
 
agx::BitState< DebugOption, agx::UInt32 > m_debugOptions
 
agx::Bool m_enableComputeMaximumNormalStressAngleFromFrontAngle {true}
 
agx::Bool m_enableComputeRearAngleFromFrontAngle {true}
 
PressureSinkageModel m_pressureSinkageModel {PressureSinkageModel::BEKKER}
 
agx::Real m_rearAndFrontAngleMaxMagnitude {agx::PI / 2}
 
agx::Real m_rollingModeOmegaYThreshold {0.017453293}
 
agx::Real m_rollingModeVxAngularEquivalentThreshold {0.017453293}
 
agx::Real m_slipAngleFallbackValue {0.078539816}
 
agx::Real m_slipAngleMaxMagnitude {0.78539816}
 
agx::Real m_slipAngleVxAngularEquivalentThreshold {0.017453293}
 
agx::Real m_slipAngleVyAngularEquivalentThreshold {0.017453293}
 
agx::Real m_slipRatioFallbackValue {0.1}
 
agx::Real m_slipRatioMaxMagnitude {1.0}
 
agx::Real m_slipRatioOmegaYThreshold {0.017453293}
 
agx::Real m_slipRatioSmoothingAngularSpeed {0.017453293}
 
agx::Real m_slipRatioVxAngularEquivalentThreshold {0.017453293}
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- 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 ()
 
- 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

Container for model-level configuration parameters.

TerrainWheelSettings groups tunable parameters that affect how the TerrainWheel model computes quantities.

The parameters stored here are typically set during model initialization or configuration and are used internally by the TerrainWheel during simulation steps.

Definition at line 39 of file TerrainWheelSettings.h.

Member Enumeration Documentation

◆ DebugOption

Debug options for info prints and additional render options.

Enumerator
PRINT_GENERAL_INFO 

Print general debug information to std::cout.

RENDER_REGRESSION_PLANES 

Render regression plane geometry (points, outlines, vectors)

PRINT_SIMULATION_STAGES 

Print simulation stages (pre, post, etc.)

PRINT_CONTACT_EVENT_INFO 

Print contact event info.

PRINT_BOUNDS_INFO 

Print bounds info.

Definition at line 506 of file TerrainWheelSettings.h.

◆ PressureSinkageModel

Enumerator
BEKKER 
REECE 

Definition at line 67 of file TerrainWheelSettings.h.

Member Function Documentation

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxTerrain::TerrainWheelSettings::AGXSTREAM_DECLARE_SERIALIZABLE_BASE ( agxTerrain::TerrainWheelSettings  )

◆ create()

static agxStream::Serializable * agxTerrain::TerrainWheelSettings::create ( agxStream::InputArchive &  )
inlinestatic

Definition at line 593 of file TerrainWheelSettings.h.

◆ getAngularIntegrationStep()

agx::Real agxTerrain::TerrainWheelSettings::getAngularIntegrationStep ( ) const

Get the angular integration step size.

Returns
Angular integration step size [rad]

◆ getDebugOption()

bool agxTerrain::TerrainWheelSettings::getDebugOption ( DebugOption  option) const
inline

Check whether a specific debug option is enabled.

Definition at line 531 of file TerrainWheelSettings.h.

◆ getEnableComputeMaximumNormalStressAngleFromFrontAngle()

bool agxTerrain::TerrainWheelSettings::getEnableComputeMaximumNormalStressAngleFromFrontAngle ( ) const
Returns
If computation of the rear angle from the front contact angle is enabled or disabled.

◆ getEnableComputeRearAngleFromFrontAngle()

bool agxTerrain::TerrainWheelSettings::getEnableComputeRearAngleFromFrontAngle ( ) const
Returns
whether the rear contact angle is computed from the front contact angle.

◆ getEnableDebugBoundsInfo()

bool agxTerrain::TerrainWheelSettings::getEnableDebugBoundsInfo ( ) const
inline

Check whether bounds debug printing is enabled.

Definition at line 591 of file TerrainWheelSettings.h.

◆ getEnableDebugContactEventInfo()

bool agxTerrain::TerrainWheelSettings::getEnableDebugContactEventInfo ( ) const
inline

Check whether contact event debug printing is enabled.

Definition at line 579 of file TerrainWheelSettings.h.

◆ getEnableDebugGeneralInfo()

bool agxTerrain::TerrainWheelSettings::getEnableDebugGeneralInfo ( ) const
inline

Check whether general debug information printing is enabled.

Definition at line 543 of file TerrainWheelSettings.h.

◆ getEnableDebugRegressionPlanes()

bool agxTerrain::TerrainWheelSettings::getEnableDebugRegressionPlanes ( ) const
inline

Check whether debug regression plane rendering is enabled.

Definition at line 555 of file TerrainWheelSettings.h.

◆ getEnableDebugSimulationStages()

bool agxTerrain::TerrainWheelSettings::getEnableDebugSimulationStages ( ) const
inline

Check whether simulation stage debug printing is enabled.

Definition at line 567 of file TerrainWheelSettings.h.

◆ getPressureSinkageModel()

PressureSinkageModel agxTerrain::TerrainWheelSettings::getPressureSinkageModel ( ) const

Get the currently selected pressure-sinkage model.

Returns
PressureSinkageModel enum which signifies the currently selected model. Either BEKKER or REECE.

◆ getRearAndFrontAngleMaxMagnitude()

agx::Real agxTerrain::TerrainWheelSettings::getRearAndFrontAngleMaxMagnitude ( ) const

Get the maximum allowed magnitude for the rear and front contact angles.

The computed front (theta_f) and rear (theta_r) contact angles are clamped to the interval [-maxMagnitude, maxMagnitude] to avoid extreme values.

Returns
The maximum absolute value allowed for theta_f and theta_r [rad]

◆ getRollingModeOmegaYThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getRollingModeOmegaYThreshold ( ) const

Return the wheel axle angular velocity magnitude threshold used to suppress rolling-mode classification.

If both the wheel-frame longitudinal velocity |vX| (evaluated via its angular equivalent) and angular velocity |omegaY| are below their respective thresholds, the rolling mode is set to the default rolling mode instead of being determined from the comparison between |R * omegaY| and |vX|.

Returns
Threshold for |omegaY| [rad/s].

◆ getRollingModeVxAngularEquivalentThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getRollingModeVxAngularEquivalentThreshold ( ) const

Return the longitudinal velocity threshold expressed as an angular-equivalent velocity used for rolling-mode classification.

The threshold corresponds to |vX| / R [rad/s]. The equivalent linear velocity threshold is |vX| < threshold * R.

If both the wheel-frame longitudinal velocity |vX| (evaluated via its angular equivalent) and angular velocity |omegaY| are below their respective thresholds, the rolling mode is set to the default rolling mode instead of being determined from the comparison between |R * omegaY| and |vX|.

Returns
Threshold for |vX| / R [rad/s].

◆ getSlipAngleFallbackValue()

agx::Real agxTerrain::TerrainWheelSettings::getSlipAngleFallbackValue ( ) const

Return the slip angle fallback value when both the vX and vY magnitudes are below their thresholds.

Returns
Slip angle fallback value [rad]

◆ getSlipAngleMaxMagnitude()

agx::Real agxTerrain::TerrainWheelSettings::getSlipAngleMaxMagnitude ( ) const

Return the maximum allowed slip angle magnitude.

Returns
Maximum allowed slip angle magnitude (clamp) [rad]

◆ getSlipAngleVxAngularEquivalentThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getSlipAngleVxAngularEquivalentThreshold ( ) const

Return the longitudinal velocity angular equivalent threshold used by the slip-angle computation.

Returns
Threshold for the angular equivalent of |vX| below which vX is stabilized away from zero [m/s]

◆ getSlipAngleVyAngularEquivalentThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getSlipAngleVyAngularEquivalentThreshold ( ) const

Return the lateral velocity dead-zone angular equivalent threshold used by the slip-angle computation.

Returns
Threshold for the angular equivalent of |vY| below which lateral velocity noise is suppressed [m/s]

◆ getSlipRatioFallbackValue()

agx::Real agxTerrain::TerrainWheelSettings::getSlipRatioFallbackValue ( ) const

Return the slip ratio fallback value when the magnitudes of both the angular equivalent of vX and omegaY are below their thresholds.

Returns
Slip ratio fallback value [-]

◆ getSlipRatioMaxMagnitude()

agx::Real agxTerrain::TerrainWheelSettings::getSlipRatioMaxMagnitude ( ) const

Return the maximum allowed magnitude of the computed slip ratio.

Returns
Maximum absolute slip ratio [-]

◆ getSlipRatioOmegaYThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getSlipRatioOmegaYThreshold ( ) const

Return the wheel axle angular velocity magnitude threshold used to suppress slip-ratio computation.

If both the wheel-frame longitudinal velocity |vX| (evaluated via its angular equivalent) and angular velocity |omegaY| are below their respective thresholds, the slip ratio is set to the fallback value (see computeSlipRatio()).

Returns
Threshold for |omegaY| [rad/s].

◆ getSlipRatioSmoothingAngularSpeed()

agx::Real agxTerrain::TerrainWheelSettings::getSlipRatioSmoothingAngularSpeed ( ) const

Return the minimum velocity scale used to stabilize slip-ratio computation.

Returns
Stabilization velocity scale smoothingAngularSpeed [rad/s]

◆ getSlipRatioVxAngularEquivalentThreshold()

agx::Real agxTerrain::TerrainWheelSettings::getSlipRatioVxAngularEquivalentThreshold ( ) const

Return the longitudinal velocity threshold expressed as an angular-equivalent velocity used for slip-ratio computations.

The threshold corresponds to |vX| / R [rad/s]. The equivalent linear velocity threshold is |vX| < threshold * R.

If both the wheel-frame longitudinal velocity |vX| (evaluated via its angular equivalent) and angular velocity |omegaY| are below their respective thresholds, the slip ratio is set to the fallback value (see computeSlipRatio()).

Returns
Threshold for |vX| / R [rad/s]

◆ setAngularIntegrationStep()

void agxTerrain::TerrainWheelSettings::setAngularIntegrationStep ( agx::Real  angularIntegrationStep)

Set the angular integration step size used by the TerrainWheel model.

This step (in radians) is the increment used when numerically integrating quantities over the wheel contact interval (typically from rear_angle to front_angle). Smaller values generally improve accuracy but increase computational cost.

Invalid values are rejected and reported with LOGGER_WARNING.

Parameters
angularIntegrationStepAngular integration step size [rad]

◆ setDebugOption()

void agxTerrain::TerrainWheelSettings::setDebugOption ( DebugOption  option,
bool  enable 
)
inline

Enable or disable a specific debug option.

Definition at line 525 of file TerrainWheelSettings.h.

◆ setEnableComputeMaximumNormalStressAngleFromFrontAngle()

void agxTerrain::TerrainWheelSettings::setEnableComputeMaximumNormalStressAngleFromFrontAngle ( bool  enable)

Enable or disable computation of the maximum normal stress angle from the front contact angle.

If enabled, the maximum normal stress theta_m is computed according to theta_m = (a_0 + a_i * slip_ratio) * theta_f, where a_0, a_1 are constants, and theta_f is front angle.

If disabled, theta_m is computed according to theta_m = 0.5 * (theta_r + theta_f), where theta_r (theta_f) is rear angle (front angle)

Parameters
enableTrue to compute theta_r from theta_f, false to use the default rear-angle update.

◆ setEnableComputeRearAngleFromFrontAngle()

void agxTerrain::TerrainWheelSettings::setEnableComputeRearAngleFromFrontAngle ( bool  enable)

Enable or disable computation of the rear contact angle from the front contact angle.

When enabled, the rear contact angle theta_r is not computed from the wheel-terrain geometry directly. Instead it is derived from the current front contact angle theta_f using an empirical slip-dependent relation (see computeRearAngleFromFrontAngle()). This can be useful when a simplified or more stable trailing-edge estimate is desired.

Parameters
enableTrue to compute theta_r from theta_f, false to use the default rear-angle update.

◆ setEnableDebugBoundsInfo()

void agxTerrain::TerrainWheelSettings::setEnableDebugBoundsInfo ( bool  enable)
inline

Enable or disable bounds info debug prints.

Definition at line 585 of file TerrainWheelSettings.h.

◆ setEnableDebugContactEventInfo()

void agxTerrain::TerrainWheelSettings::setEnableDebugContactEventInfo ( bool  enable)
inline

Enable or disable contact event info debug prints.

Definition at line 573 of file TerrainWheelSettings.h.

◆ setEnableDebugGeneralInfo()

void agxTerrain::TerrainWheelSettings::setEnableDebugGeneralInfo ( bool  enable)
inline

Enable or disable general debug prints.

Definition at line 537 of file TerrainWheelSettings.h.

◆ setEnableDebugRegressionPlanes()

void agxTerrain::TerrainWheelSettings::setEnableDebugRegressionPlanes ( bool  enable)
inline

Enable or disable debug rendering of regression planes.

Definition at line 549 of file TerrainWheelSettings.h.

◆ setEnableDebugSimulationStages()

void agxTerrain::TerrainWheelSettings::setEnableDebugSimulationStages ( bool  enable)
inline

Enable or disable simulation stage debug prints.

Definition at line 561 of file TerrainWheelSettings.h.

◆ setPressureSinkageModel()

void agxTerrain::TerrainWheelSettings::setPressureSinkageModel ( PressureSinkageModel  pressureSinkageModel)

Set the pressure-sinkage model used by the TerrainWheel model.

Selects which semi-empirical relation is used to compute normal pressure as a function of sinkage. Currently supported models are "Bekker" and "Reece". In the "Bekker" model, the pressure is written on the form

p = (k_c/b + k_phi) * z^n,

while in the "Reece" model, the pressure is written on the form

p = (c*k_c' + rho*g*b*k_phi') * (z/b)^n.
Parameters
pressureSinkageModelEnum to choose pressure sinkage model, see PressureSinkageModel.

◆ setRearAndFrontAngleMaxMagnitude()

void agxTerrain::TerrainWheelSettings::setRearAndFrontAngleMaxMagnitude ( agx::Real  maxMagnitude)

Set the maximum allowed magnitude for the rear and front contact angles.

The computed front (theta_f) and rear (theta_r) contact angles are clamped to the interval [-maxMagnitude, maxMagnitude] to avoid extreme values.

Parameters
maxMagnitudeMaximum absolute value allowed for theta_f and theta_r [rad]

◆ setRollingModeOmegaYThreshold()

void agxTerrain::TerrainWheelSettings::setRollingModeOmegaYThreshold ( agx::Real  omegaYThreshold)

Set the threshold for the wheel axle angular velocity magnitude used to suppress rolling-mode classification from noisy low-speed kinematics.

If both:

  • the longitudinal velocity magnitude |vX| (evaluated via its angular equivalent), and
  • the wheel axle angular velocity magnitude |omegaY| are below their respective thresholds, the rolling mode is set to the default rolling mode instead of being determined from the comparison between |R * omegaY| and |vX|.
Parameters
omegaYThresholdThreshold for |omegaY| [rad/s]. Must be >= 0.

◆ setRollingModeVxAngularEquivalentThreshold()

void agxTerrain::TerrainWheelSettings::setRollingModeVxAngularEquivalentThreshold ( agx::Real  vXAngEquivThreshold)

Set the threshold for the longitudinal wheel velocity expressed as an angular-equivalent velocity used to suppress rolling-mode classification from noisy low-speed kinematics.

The longitudinal velocity vX is converted to an angular equivalent by dividing by the wheel radius R, i.e. |vX| / R.

If both:

  • the longitudinal velocity magnitude |vX| (evaluated via its angular equivalent), and
  • the wheel axle angular velocity magnitude |omegaY| are below their respective thresholds, the rolling mode is set to the default rolling mode instead of being determined from the comparison between |R * omegaY| and |vX|.

The corresponding linear velocity threshold is: |vX| < vXAngEquivThreshold * R

Parameters
vXAngEquivThresholdThreshold for |vX| / R [rad/s]. Must be >= 0.

◆ setSlipAngleFallbackValue()

void agxTerrain::TerrainWheelSettings::setSlipAngleFallbackValue ( agx::Real  fallbackValue)

Set the fallback slip angle value when both vX and vY magnitudes are below their thresholds.

The lateral force due to shear stress is zero when tan(slip angle) is zero, i.e. when slip angle is zero. The lateral force due to bulldozing is zero when sin(slip angle) is zero, i.e. when slip angle is zero. When vX and vY are small, the slip angle computation is unreliable due to e.g. noise, so when vX and vY are below their thresholds, the slip angle is set to fallbackValue. If fallbackValue is set to zero, and vX and vY are below their thresholds, the lateral force constraint limit is zero, disabling the possibility to produce a lateral force. This can be an issue e.g. when a wheel should be stationary at a (very) small incline, but drifts laterally. Therefore, it is recommended that fallbackValue is set to some non-zero value.

Invalid values are rejected and reported with LOGGER_WARNING.

Parameters
fallbackValueFallback slip angle value [rad]

◆ setSlipAngleMaxMagnitude()

void agxTerrain::TerrainWheelSettings::setSlipAngleMaxMagnitude ( agx::Real  maxMagnitude)

Set the maximum allowed slip-angle magnitude.

The computed slip angle is clamped to +/- this value to avoid unrealistic angles and to improve numerical stability.

Invalid values are rejected and reported with LOGGER_WARNING.

Parameters
maxMagnitudeMaximum allowed slip angle magnitude (clamp) [rad]

◆ setSlipAngleVxAngularEquivalentThreshold()

void agxTerrain::TerrainWheelSettings::setSlipAngleVxAngularEquivalentThreshold ( agx::Real  vXAngEquivThreshold)

Set the longitudinal velocity angular equivalent threshold used by the slip-angle computation.

When computing the wheel slip angle (atan2(vY, vX)), a small |vX| can cause numerical noise and discontinuities around vX = 0. This threshold is used to stabilize/clamp vX away from zero in that regime.

The longitudinal velocity angular equivalent threshold is vXAngEquivThreshold * radius.

The value must be >= 0.

Parameters
vXAngEquivThresholdThreshold for the angular equivalent of |vX| below which vX is stabilized away from zero [m/s]

◆ setSlipAngleVyAngularEquivalentThreshold()

void agxTerrain::TerrainWheelSettings::setSlipAngleVyAngularEquivalentThreshold ( agx::Real  vYAngEquivThreshold)

Set the lateral velocity dead-zone angular equivalent threshold used by the slip-angle computation.

Small lateral velocities are treated as noise and suppressed when computing the slip angle. This threshold defines the |vY| below which vY is considered zero.

The lateral velocity angular equivalent threshold is vYAngEquivThreshold * radius.

The value must be >= 0.

Parameters
vYAngEquivThresholdThreshold for the angular equivalent of |vY| below which lateral velocity noise is suppressed [m/s]

◆ setSlipRatioFallbackValue()

void agxTerrain::TerrainWheelSettings::setSlipRatioFallbackValue ( agx::Real  fallbackValue)

Set the fallback slip ratio value when both the vX and omegaY magnitudes are below their respective thresholds.

Invalid values are rejected and reported with LOGGER_WARNING.

Parameters
fallbackValueFallback slip ratio value [-]

◆ setSlipRatioMaxMagnitude()

void agxTerrain::TerrainWheelSettings::setSlipRatioMaxMagnitude ( agx::Real  maxMagnitude)

Set the maximum allowed magnitude of the computed slip ratio.

The slip ratio is clamped to [-maxMagnitude, +maxMagnitude] in computeSlipRatio() to prevent extreme values.

Parameters
maxMagnitudeMaximum absolute slip ratio [-]. Must be >= 0.

◆ setSlipRatioOmegaYThreshold()

void agxTerrain::TerrainWheelSettings::setSlipRatioOmegaYThreshold ( agx::Real  omegaYThreshold)

Set the threshold for the wheel axle axis angular velocity magnitude used to suppress slip-ratio computations.

If both:

  • the longitudinal velocity magnitude |vX| (evaluated via its angular equivalent), and
  • the wheel axle angular velocity magnitude |omegaY| are below their respective thresholds, the slip ratio is set to a fallback value (see computeSlipRatio()).
Parameters
omegaYThresholdThreshold for |omegaY| [rad/s]. Must be >= 0.

◆ setSlipRatioSmoothingAngularSpeed()

void agxTerrain::TerrainWheelSettings::setSlipRatioSmoothingAngularSpeed ( agx::Real  smoothingAngularSpeed)

Set the minimum velocity scale used to smooth slip-ratio computations.

The slip-ratio expression is smoothly attenuated at very low speeds using a velocity-dependent factor based on smoothingAngularSpeed (see computeSlipRatio()) to avoid numerical issues around standstill. A larger smoothingAngularSpeed implies a greater smoothing.

Parameters
smoothingAngularSpeedMinimum velocity scale [rad/s]. Must be > 0.

◆ setSlipRatioVxAngularEquivalentThreshold()

void agxTerrain::TerrainWheelSettings::setSlipRatioVxAngularEquivalentThreshold ( agx::Real  vXAngEquivThreshold)

Set the threshold for the longitudinal wheel velocity expressed as an angular-equivalent velocity used to suppress slip-ratio computations.

The longitudinal velocity vX is converted to an angular equivalent by dividing by the wheel radius R, i.e. |vX| / R.

If both:

  • the longitudinal velocity magnitude |vX| (evaluated via its angular equivalent), and
  • the wheel axle angular velocity magnitude |omegaY| are below their respective thresholds, the slip ratio is set to a fallback value (see computeSlipRatio()).

The corresponding linear velocity threshold is: |vX| < vXAngEquivThreshold * R

Parameters
vXAngEquivThresholdThreshold for |vX| / R [rad/s]. Must be >= 0.

Member Data Documentation

◆ m_angularIntegrationStep

agx::Real agxTerrain::TerrainWheelSettings::m_angularIntegrationStep {0.001}
protected

Definition at line 596 of file TerrainWheelSettings.h.

◆ m_debugOptions

agx::BitState<DebugOption, agx::UInt32> agxTerrain::TerrainWheelSettings::m_debugOptions
protected

Definition at line 612 of file TerrainWheelSettings.h.

◆ m_enableComputeMaximumNormalStressAngleFromFrontAngle

agx::Bool agxTerrain::TerrainWheelSettings::m_enableComputeMaximumNormalStressAngleFromFrontAngle {true}
protected

Definition at line 599 of file TerrainWheelSettings.h.

◆ m_enableComputeRearAngleFromFrontAngle

agx::Bool agxTerrain::TerrainWheelSettings::m_enableComputeRearAngleFromFrontAngle {true}
protected

Definition at line 598 of file TerrainWheelSettings.h.

◆ m_pressureSinkageModel

PressureSinkageModel agxTerrain::TerrainWheelSettings::m_pressureSinkageModel {PressureSinkageModel::BEKKER}
protected

Definition at line 597 of file TerrainWheelSettings.h.

◆ m_rearAndFrontAngleMaxMagnitude

agx::Real agxTerrain::TerrainWheelSettings::m_rearAndFrontAngleMaxMagnitude {agx::PI / 2}
protected

Definition at line 600 of file TerrainWheelSettings.h.

◆ m_rollingModeOmegaYThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_rollingModeOmegaYThreshold {0.017453293}
protected

Definition at line 611 of file TerrainWheelSettings.h.

◆ m_rollingModeVxAngularEquivalentThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_rollingModeVxAngularEquivalentThreshold {0.017453293}
protected

Definition at line 610 of file TerrainWheelSettings.h.

◆ m_slipAngleFallbackValue

agx::Real agxTerrain::TerrainWheelSettings::m_slipAngleFallbackValue {0.078539816}
protected

Definition at line 609 of file TerrainWheelSettings.h.

◆ m_slipAngleMaxMagnitude

agx::Real agxTerrain::TerrainWheelSettings::m_slipAngleMaxMagnitude {0.78539816}
protected

Definition at line 608 of file TerrainWheelSettings.h.

◆ m_slipAngleVxAngularEquivalentThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_slipAngleVxAngularEquivalentThreshold {0.017453293}
protected

Definition at line 606 of file TerrainWheelSettings.h.

◆ m_slipAngleVyAngularEquivalentThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_slipAngleVyAngularEquivalentThreshold {0.017453293}
protected

Definition at line 607 of file TerrainWheelSettings.h.

◆ m_slipRatioFallbackValue

agx::Real agxTerrain::TerrainWheelSettings::m_slipRatioFallbackValue {0.1}
protected

Definition at line 605 of file TerrainWheelSettings.h.

◆ m_slipRatioMaxMagnitude

agx::Real agxTerrain::TerrainWheelSettings::m_slipRatioMaxMagnitude {1.0}
protected

Definition at line 604 of file TerrainWheelSettings.h.

◆ m_slipRatioOmegaYThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_slipRatioOmegaYThreshold {0.017453293}
protected

Definition at line 602 of file TerrainWheelSettings.h.

◆ m_slipRatioSmoothingAngularSpeed

agx::Real agxTerrain::TerrainWheelSettings::m_slipRatioSmoothingAngularSpeed {0.017453293}
protected

Definition at line 603 of file TerrainWheelSettings.h.

◆ m_slipRatioVxAngularEquivalentThreshold

agx::Real agxTerrain::TerrainWheelSettings::m_slipRatioVxAngularEquivalentThreshold {0.017453293}
protected

Definition at line 601 of file TerrainWheelSettings.h.


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