SuperDex Physics C++ API
Loading...
Searching...
No Matches
superdex::ContactPairParamsOverride Struct Reference

Optional contact-response parameter replacements for an unordered actor pair. More...

#include <mochi_structs.h>

Public Member Functions

bool operator== (ContactPairParamsOverride const &) const =default

Public Attributes

std::optional< real > coulombFrictionCoefficient
 Pair Coulomb friction coefficient.
std::optional< real > frictionFalloffVel
 Friction falloff velocity [m/s].
std::optional< real > normalViscousDampingCoefficient
 Pair normal viscous damping coefficient [s/m].
std::optional< real > penaltyCoefficient
 Pair penalty coefficient [Pa/m] before role-dependent dimensional corrections.
std::optional< real > viscousFrictionCoefficient
 Pair viscous friction coefficient [s/m].

Detailed Description

Optional contact-response parameter replacements for an unordered actor pair.

Each present field replaces the value normally combined from the two actors. An absent field retains the existing combination rule.

Note
Present fields have the same validity requirements as the corresponding ContactParams fields. A present zero is a value subject to those requirements, not an absent field.

Definition at line 54 of file mochi_structs.h.

Member Function Documentation

◆ operator==()

bool superdex::ContactPairParamsOverride::operator== ( ContactPairParamsOverride const & ) const
default

Member Data Documentation

◆ coulombFrictionCoefficient

std::optional<real> superdex::ContactPairParamsOverride::coulombFrictionCoefficient

Pair Coulomb friction coefficient.

See also
ContactParams::coulombFrictionCoefficient

Definition at line 61 of file mochi_structs.h.

◆ frictionFalloffVel

std::optional<real> superdex::ContactPairParamsOverride::frictionFalloffVel

Friction falloff velocity [m/s].

See also
ContactParams::frictionFalloffVel

Definition at line 57 of file mochi_structs.h.

◆ normalViscousDampingCoefficient

std::optional<real> superdex::ContactPairParamsOverride::normalViscousDampingCoefficient

Pair normal viscous damping coefficient [s/m].

See also
ContactParams::normalViscousDampingCoefficient

Definition at line 63 of file mochi_structs.h.

◆ penaltyCoefficient

std::optional<real> superdex::ContactPairParamsOverride::penaltyCoefficient

Pair penalty coefficient [Pa/m] before role-dependent dimensional corrections.

See also
ContactParams::penaltyCoefficient

Definition at line 55 of file mochi_structs.h.

◆ viscousFrictionCoefficient

std::optional<real> superdex::ContactPairParamsOverride::viscousFrictionCoefficient

Pair viscous friction coefficient [s/m].

See also
ContactParams::viscousFrictionCoefficient

Definition at line 59 of file mochi_structs.h.


The documentation for this struct was generated from the following files: