Simbody  3.5
SimTK::ContactForceGenerator::ThrowError Class Reference

This ContactForceGenerator throws an error if it is every invoked. More...

+ Inheritance diagram for SimTK::ContactForceGenerator::ThrowError:

Public Member Functions

 ThrowError (ContactTypeId type=ContactTypeId(0))
 
void calcContactForce (const State &state, const Contact &overlapping, const SpatialVec &V_S1S2, ContactForce &contactForce) const override
 The CompliantContactSubsystem will invoke this method on any active contact pair of the right Contact type for which there is overlapping undeformed geometry. More...
 
void calcContactPatch (const State &state, const Contact &overlapping, const SpatialVec &V_S1S2, ContactPatch &patch) const override
 The CompliantContactSubsystem will invoke this method in response to a user request for contact patch information; this returns force, potential energy, and power as above but may also require expensive computations that can be avoided in calcContactForce(). More...
 
- Public Member Functions inherited from SimTK::ContactForceGenerator
 ContactForceGenerator (ContactTypeId type)
 Base class constructor for use by the concrete classes. More...
 
ContactTypeId getContactTypeId () const
 Return the ContactTypeId handled by this force generator. More...
 
const CompliantContactSubsystemgetCompliantContactSubsystem () const
 
void setCompliantContactSubsystem (const CompliantContactSubsystem *sub)
 
virtual ~ContactForceGenerator ()
 Base class destructor is virtual but does nothing. More...
 

Detailed Description

This ContactForceGenerator throws an error if it is every invoked.

It can be used as a way to explicitly catch a certain ContactTypeId and complain, or more commonly it is used as the fallback generator for unrecognized ContactTypeIds.

Constructor & Destructor Documentation

Member Function Documentation

void SimTK::ContactForceGenerator::ThrowError::calcContactForce ( const State state,
const Contact overlapping,
const SpatialVec V_S1S2,
ContactForce contactForce 
) const
inlineoverridevirtual

The CompliantContactSubsystem will invoke this method on any active contact pair of the right Contact type for which there is overlapping undeformed geometry.

The force generator is expected to calculate a point in space where equal and opposite contact forces should be applied to the two contacting rigid bodies, the potential energy currently stored in this contact, and the power (energy dissipation rate). State should be used for instance info only; use position information from overlapping and velocity information from the supplied arguments. That allows this method to be used as an operator, for example to calculate potential energy when velocities are not yet available.

Implements SimTK::ContactForceGenerator.

void SimTK::ContactForceGenerator::ThrowError::calcContactPatch ( const State state,
const Contact overlapping,
const SpatialVec V_S1S2,
ContactPatch patch 
) const
inlineoverridevirtual

The CompliantContactSubsystem will invoke this method in response to a user request for contact patch information; this returns force, potential energy, and power as above but may also require expensive computations that can be avoided in calcContactForce().

Don't use the state for position or velocity information; the only allowed positions are in the Contact object and the velocities are supplied explicitly.

Implements SimTK::ContactForceGenerator.


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