IRockyMaterialInteraction Struct Reference
Last update: 08.07.2024
IRockyMaterialInteraction Struct Reference
#include <rocky_material_api.hpp>
Public Member Functions | |
| ROCKY_FUNCTIONS double | get_restitution_coefficient () const |
| ROCKY_FUNCTIONS double | get_minimum_restitution_coefficient () const |
| ROCKY_FUNCTIONS double | get_static_friction_coefficient () const |
| ROCKY_FUNCTIONS double | get_dynamic_friction_coefficient () const |
| ROCKY_FUNCTIONS double | get_stiffness_multiplier () const |
| ROCKY_FUNCTIONS double | get_tangential_stiffness_ratio () const |
Detailed Description
IRockyMaterialInteraction is an interface for the internal material interaction object, which gives access to values of the physical properties associated to contacts involving combinations of two materials. The values of all those properties are dimensionless values.
Member Function Documentation
◆ get_dynamic_friction_coefficient()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_dynamic_friction_coefficient | ( | ) | const |
- Returns
- The value of the dynamic coefficient of friction, which is used in tangential force models when there exists tangential relative motion between two contacting entities.
◆ get_minimum_restitution_coefficient()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_minimum_restitution_coefficient | ( | ) | const |
- Returns
- The value of the minimum restitution coefficient set by a module implementing a variable restitution coefficient model. This value can be used to estimate the stable timestep for a custom contact model. If the given project does not include a module that implements a variable restitution coefficient model, the constant value specified through the Rocky UI will be returned.
◆ get_restitution_coefficient()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_restitution_coefficient | ( | ) | const |
- Returns
- The value of the coefficient of restitution, which indirectly specifies the amount of energy dissipation in a normal collision.
- Attention
- The value returned by this function is always the one prescribed through the Rocky UI, therefore, it is not affected by changes introduced by a module implementing a variable restitution coefficient model.
◆ get_static_friction_coefficient()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_static_friction_coefficient | ( | ) | const |
- Returns
- The value of the static coefficient of friction, which is used in tangential force models when there is no tangential relative motion between two contacting entities.
◆ get_stiffness_multiplier()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_stiffness_multiplier | ( | ) | const |
- Returns
- The value of the stiffness multiplier, which is used to increase the stiffness in collisions in order to prevent large overlap values.
◆ get_tangential_stiffness_ratio()
| ROCKY_FUNCTIONS double IRockyMaterialInteraction::get_tangential_stiffness_ratio | ( | ) | const |
- Returns
- The value of the tangential stiffness ratio, which is used in tangential force models to relate the tangential stiffness to the normal stiffness at a contact between two contacting entities.