IRockyAdhesionOutputData Struct Reference
Last update: 08.07.2024
IRockyAdhesionOutputData Struct Reference
#include <rocky_contact_output_data_api.hpp>
Public Member Functions | |
ROCKY_FUNCTIONS void | set_normal_force (double value) |
ROCKY_FUNCTIONS void | set_tangential_force (double3 value) |
Detailed Description
IRockyAdhesionOutputData
is an interface to define some property values related to an adhesive contact in a custom adhesion model. The values defined through this interface include the normal and tangential components of the adhesion force.
Member Function Documentation
◆ set_normal_force()
ROCKY_FUNCTIONS void IRockyAdhesionOutputData::set_normal_force | ( | double | value | ) |
- This method sets the value of the normal component of the adhesion force calculated by a custom
- adhesion model. Rocky will sum this force to both entities associated to the contact (two particles or a particle and a geometry triangle) using the appropriate signs. Please note that since an adhesion force is attractive, normally it must be defined with a negative sign (i.e. its orientation must be opposite to the normal component of the contact force).
- Parameters
-
value The normal component of the adhesive force just calculated using a custom adhesion model.
◆ set_tangential_force()
ROCKY_FUNCTIONS void IRockyAdhesionOutputData::set_tangential_force | ( | double3 | value | ) |
- This method can be used to set the value of the tangential component of the adhesion force
- calculated by a custom adhesion model. Rocky will sum this force to both entities associated to the contact (two particles or a particle and a geometry triangle) using the appropriate signs. The use of this function is optional, since only in specific cases (like in a liquid bridge model) an adhesion model will need to specify a tangential force component.
- Parameters
-
value The tangential component of the adhesive force expressed in Cartesian coordinates.