API  4.0
For C++ developers
List of all members | Public Member Functions | Public Attributes | Friends
OpenSim::Muscle::MusclePotentialEnergyInfo Struct Reference

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

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, calcMusclePotentialEnergyInfo, can be called when position information is known. This function is dependent on calcMuscleLengthInfo.

NAME DIMENSION UNITS fiberPotentialEnergy force*distance J (Nm) [1] tendonPotentialEnergy force*distance J (Nm) [2] musclePotentialEnergy 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 calcMusclePotentialEnergyInfo, that might be useful for others to access.

Constructor & Destructor Documentation

◆ MusclePotentialEnergyInfo()

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

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ fiberPotentialEnergy

double OpenSim::Muscle::MusclePotentialEnergyInfo::fiberPotentialEnergy

◆ musclePotentialEnergy

double OpenSim::Muscle::MusclePotentialEnergyInfo::musclePotentialEnergy

◆ tendonPotentialEnergy

double OpenSim::Muscle::MusclePotentialEnergyInfo::tendonPotentialEnergy

◆ userDefinedPotentialEnergyExtras

SimTK::Vector OpenSim::Muscle::MusclePotentialEnergyInfo::userDefinedPotentialEnergyExtras
The documentation for this struct was generated from the following file: