OpenSim  OpenSim 3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::Muscle::MusclePotentialEnergyInfo Struct Reference

MusclePotentialEnergyInfo contains quantities related to the potential energy of the muscle (fiber + tendon) complex. More...

#include <Muscle.h>

Public Member Functions

 MusclePotentialEnergyInfo ()

Public Attributes

double fiberPotentialEnergy
double tendonPotentialEnergy
double musclePotentialEnergy
SimTK::Vector userDefinedPotentialEnergyExtras

Friends

std::ostream & operator<< (std::ostream &o, const MusclePotentialEnergyInfo &fvi)

Detailed Description

MusclePotentialEnergyInfo contains quantities related to the potential energy of the muscle (fiber + tendon) complex.

The function that populates this struct, calcMusclePotentialEnrgyInfo, can be called when position information is known. This function is the dependendent on calcMuscleLengthInfo.

NAME DIMENSION UNITS fiberPotentalEnergy force*distance J (Nm) [1] tendonPotentalEnergy force*distance J (Nm) [2] musclePotentalEnergy force*distance J (Nm) [3]

userDefinedPotentialEnergyExtras [4]

[4] This vector is left for the muscle modeler to populate with any computationally expensive quantities that are computed in calcMusclePotentialEnrgyInfo, that might be useful for others to access.

Constructor & Destructor Documentation

OpenSim::Muscle::MusclePotentialEnergyInfo::MusclePotentialEnergyInfo ( )
inline

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const MusclePotentialEnergyInfo fvi 
)
friend

Member Data Documentation

double OpenSim::Muscle::MusclePotentialEnergyInfo::fiberPotentialEnergy
double OpenSim::Muscle::MusclePotentialEnergyInfo::musclePotentialEnergy
double OpenSim::Muscle::MusclePotentialEnergyInfo::tendonPotentialEnergy
SimTK::Vector OpenSim::Muscle::MusclePotentialEnergyInfo::userDefinedPotentialEnergyExtras

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