SimTK::Force::ConstantForce Class Reference

A constant force applied to a body station. More...

#include <Force.h>

Inheritance diagram for SimTK::Force::ConstantForce:

Public Member Functions
	ConstantForce (GeneralForceSubsystem &forces, const MobilizedBody &body, const Vec3 &station, const Vec3 &force)
	ConstantForce ()
	Default constructor creates an empty handle.
	SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS (ConstantForce, ConstantForceImpl, Force)
Public Member Functions inherited from SimTK::Force
void	disable (State &) const
	Disable this force element, effectively removing it from the System for computational purposes (it is still using its ForceIndex, however).
void	enable (State &) const
	Enable this force element if it was previously disabled.
bool	isDisabled (const State &) const
	Test whether this force element is currently disabled in the supplied State.
void	setDisabledByDefault (bool shouldBeDisabled)
	Normally force elements are enabled when defined and can be disabled later.
bool	isDisabledByDefault () const
	Test whether this force element is disabled by default in which case it must be explicitly enabled before it will take effect.
void	calcForceContribution (const State &state, Vector_< SpatialVec > &bodyForces, Vector_< Vec3 > &particleForces, Vector &mobilityForces) const
	Calculate the force that would be applied by this force element if the given state were realized to Dynamics stage.
Real	calcPotentialEnergyContribution (const State &state) const
	Calculate the potential energy contribution that is made by this force element at the given state.
	Force ()
	Default constructor for Force handle base class does nothing.
	operator ForceIndex () const
	Implicit conversion to ForceIndex when needed.
const GeneralForceSubsystem &	getForceSubsystem () const
	Get the GeneralForceSubsystem of which this Force is an element.
ForceIndex	getForceIndex () const
	Get the index of this force element within its parent force subsystem.
Public Member Functions inherited from SimTK::PIMPLHandle< Force, ForceImpl, true >
bool	isEmptyHandle () const
	Returns true if this handle is empty, that is, does not refer to any implementation object.
bool	isOwnerHandle () const
	Returns true if this handle is the owner of the implementation object to which it refers.
bool	isSameHandle (const Force &other) const
	Determine whether the supplied handle is the same object as "this" PIMPLHandle.
void	disown (Force &newOwner)
	Give up ownership of the implementation to an empty handle.
PIMPLHandle &	referenceAssign (const Force &source)
	"Copy" assignment but with shallow (pointer) semantics.
PIMPLHandle &	copyAssign (const Force &source)
	This is real copy assignment, with ordinary C++ object ("value") semantics.
void	clearHandle ()
	Make this an empty handle, deleting the implementation object if this handle is the owner of it.
const ForceImpl &	getImpl () const
	Get a const reference to the implementation associated with this Handle.
ForceImpl &	updImpl ()
	Get a writable reference to the implementation associated with this Handle.
int	getImplHandleCount () const
	Return the number of handles the implementation believes are referencing it.

Additional Inherited Members
Public Types inherited from SimTK::PIMPLHandle< Force, ForceImpl, true >
typedef PIMPLHandle< Force, ForceImpl, PTR >	HandleBase
typedef HandleBase	ParentHandle
Protected Member Functions inherited from SimTK::Force
	Force (ForceImpl *r)
	Use this in a derived Force handle class constructor to supply the concrete implementation object to be stored in the handle base.

Detailed Description

A constant force applied to a body station.

The force is a vector fixed forever in the Ground frame. This force does not contribute to the potential energy, so adding it to a system will cause energy not to be conserved.

Constructor & Destructor Documentation

SimTK::Force::ConstantForce::ConstantForce	(	GeneralForceSubsystem &	forces,
		const MobilizedBody &	body,
		const Vec3 &	station,
		const Vec3 &	force
	)

SimTK::Force::ConstantForce::ConstantForce ( )

inline

Default constructor creates an empty handle.

Member Function Documentation

SimTK::Force::ConstantForce::SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS	(	ConstantForce	,
		ConstantForceImpl	,
		Force
	)

---

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

• Force.h