Umberger2010MuscleMetabolicsProbe is a Probe ModelComponent for computing the net metabolic energy rate of a set of Muscles in the model during a simulation. More...

Inheritance diagram for OpenSim::Umberger2010MuscleMetabolicsProbe:

OpenSim Properties, Sockets, Outputs, Inputs
Properties (single-value)
Default value = true
bool	activation_maintenance_rate_on
	"Specify whether activation & maintenance heat rate is to be calculated (true/false)." More...

bool	shortening_rate_on
	"Specify whether shortening heat rate is to be calculated (true/false)." More...

bool	basal_rate_on
	"Specify whether basal heat rate is to be calculated (true/false)." More...

bool	mechanical_work_rate_on
	"Specify whether mechanical work rate is to be calculated (true/false)." More...

bool	enforce_minimum_heat_rate_per_muscle
	"Specify whether the total heat rate for a muscle will be clamped to a " "minimum value of 1.0 W/kg (true/false)." More...

double	aerobic_factor
	"Aerobic scale factor (S=1.0 for primarily anaerobic conditions and S=1.5 " "for primarily aerobic conditions. See Umberger et al., (2003)." More...

double	basal_coefficient
	"Basal metabolic coefficient." More...

double	basal_exponent
	"Basal metabolic exponent." More...

double	muscle_effort_scaling_factor
	"Scale the excitation and activation values used by the probe to " "compensate for solutions with excessive coactivation (e.g., when a " "suboptimal tracking strategy is used)." More...

bool	use_Bhargava_recruitment_model
	"Specify whether the recruitment model described by Bhargava et al. " "(2004) will used to determine the slow-twitch fiber ratio " "(true/false). Disable to use the model as published in Umberger " "(2010)." More...

bool	include_negative_mechanical_work
	"Specify whether negative mechanical work will be included in Wdot and " "a coefficient of 4.0 will be used to calculate alpha_L (true/false). " "Disable to use the model as published in Umberger (2010)." More...

bool	forbid_negative_total_power
	"Specify whether the total power for each muscle must remain positive " "(true/false). Disable to use the model as published in Umberger " "(2010)." More...

bool	report_total_metabolics_only
	"If set to false, the individual muscle metabolics, basal rate, and " "total summation will be reported. If set to true, only the total " "summation will be reported." More...

Properties (unnamed)
Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet	Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet
	"A set containing, for each muscle, the parameters " "required to calculate muscle metabolic power." More...

OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Probe
bool	enabled
	"Flag indicating whether the Probe is Enabled." More...

std::string	probe_operation
	"The operation to perform on the probe input value: " "'value'(no operation, just return the probe value), 'integrate', " "'differentiate', 'minimum', 'minabs', 'maximum', 'maxabs'." More...

double	gain
	"Constant gain to scale the probe output by." More...

double	initial_conditions_for_integration
	"Array of initial conditions to be specified if the 'integrate' operation is " "selected. Note that the size of initial conditions must be the same size as " "the data being integrated, otherwise an exception will be thrown." More...

SimTK::Vector	probe_outputs
	Provides the value of getProbeOutputs() and is available at stage SimTK::Stage::Report . More...

OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Component
Component	components
	"List of components that this component owns and serializes." More...

Public Member Functions
	Umberger2010MuscleMetabolicsProbe ()
	Default constructor. More...

	Umberger2010MuscleMetabolicsProbe (const bool activation_maintenance_rate_on, const bool shortening_rate_on, const bool basal_rate_on, const bool work_rate_on)
	Convenience constructor. More...

virtual SimTK::Vector	computeProbeInputs (const SimTK::State &state) const override
	Compute muscle metabolic power. More...

int	getNumProbeInputs () const override
	Returns the number of probe inputs in the vector returned by computeProbeInputs(). More...

virtual OpenSim::Array< std::string >	getProbeOutputLabels () const override
	Returns the column labels of the probe values for reporting. More...

Property-related functions
const bool &	get_activation_maintenance_rate_on () const
	Get the value of the activation_maintenance_rate_on property. More...

bool &	upd_activation_maintenance_rate_on ()
	Get a writable reference to the activation_maintenance_rate_on property. More...

void	set_activation_maintenance_rate_on (const bool &value)
	Set the value of the activation_maintenance_rate_on property. More...

const bool &	get_shortening_rate_on () const
	Get the value of the shortening_rate_on property. More...

bool &	upd_shortening_rate_on ()
	Get a writable reference to the shortening_rate_on property. More...

void	set_shortening_rate_on (const bool &value)
	Set the value of the shortening_rate_on property. More...

const bool &	get_basal_rate_on () const
	Get the value of the basal_rate_on property. More...

bool &	upd_basal_rate_on ()
	Get a writable reference to the basal_rate_on property. More...

void	set_basal_rate_on (const bool &value)
	Set the value of the basal_rate_on property. More...

const bool &	get_mechanical_work_rate_on () const
	Get the value of the mechanical_work_rate_on property. More...

bool &	upd_mechanical_work_rate_on ()
	Get a writable reference to the mechanical_work_rate_on property. More...

void	set_mechanical_work_rate_on (const bool &value)
	Set the value of the mechanical_work_rate_on property. More...

const bool &	get_enforce_minimum_heat_rate_per_muscle () const
	Get the value of the enforce_minimum_heat_rate_per_muscle property. More...

bool &	upd_enforce_minimum_heat_rate_per_muscle ()
	Get a writable reference to the enforce_minimum_heat_rate_per_muscle property. More...

void	set_enforce_minimum_heat_rate_per_muscle (const bool &value)
	Set the value of the enforce_minimum_heat_rate_per_muscle property. More...

const double &	get_aerobic_factor () const
	Get the value of the aerobic_factor property. More...

double &	upd_aerobic_factor ()
	Get a writable reference to the aerobic_factor property. More...

void	set_aerobic_factor (const double &value)
	Set the value of the aerobic_factor property. More...

const double &	get_basal_coefficient () const
	Get the value of the basal_coefficient property. More...

double &	upd_basal_coefficient ()
	Get a writable reference to the basal_coefficient property. More...

void	set_basal_coefficient (const double &value)
	Set the value of the basal_coefficient property. More...

const double &	get_basal_exponent () const
	Get the value of the basal_exponent property. More...

double &	upd_basal_exponent ()
	Get a writable reference to the basal_exponent property. More...

void	set_basal_exponent (const double &value)
	Set the value of the basal_exponent property. More...

const double &	get_muscle_effort_scaling_factor () const
	Get the value of the muscle_effort_scaling_factor property. More...

double &	upd_muscle_effort_scaling_factor ()
	Get a writable reference to the muscle_effort_scaling_factor property. More...

void	set_muscle_effort_scaling_factor (const double &value)
	Set the value of the muscle_effort_scaling_factor property. More...

const bool &	get_use_Bhargava_recruitment_model () const
	Get the value of the use_Bhargava_recruitment_model property. More...

bool &	upd_use_Bhargava_recruitment_model ()
	Get a writable reference to the use_Bhargava_recruitment_model property. More...

void	set_use_Bhargava_recruitment_model (const bool &value)
	Set the value of the use_Bhargava_recruitment_model property. More...

const bool &	get_include_negative_mechanical_work () const
	Get the value of the include_negative_mechanical_work property. More...

bool &	upd_include_negative_mechanical_work ()
	Get a writable reference to the include_negative_mechanical_work property. More...

void	set_include_negative_mechanical_work (const bool &value)
	Set the value of the include_negative_mechanical_work property. More...

const bool &	get_forbid_negative_total_power () const
	Get the value of the forbid_negative_total_power property. More...

bool &	upd_forbid_negative_total_power ()
	Get a writable reference to the forbid_negative_total_power property. More...

void	set_forbid_negative_total_power (const bool &value)
	Set the value of the forbid_negative_total_power property. More...

const bool &	get_report_total_metabolics_only () const
	Get the value of the report_total_metabolics_only property. More...

bool &	upd_report_total_metabolics_only ()
	Get a writable reference to the report_total_metabolics_only property. More...

void	set_report_total_metabolics_only (const bool &value)
	Set the value of the report_total_metabolics_only property. More...

const Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet &	get_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet () const
	Get the value of the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property. More...

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet &	upd_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet ()
	Get a writable reference to the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property. More...

void	set_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet (const Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet &value)
	Set the value of the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property. More...

Public Member Functions inherited from OpenSim::Probe
	Probe ()

void	reset (SimTK::State &s)
	Reset (initialize) the underlying Probe SimTK::Measure. More...

int	getNumInternalMeasureStates () const
	Get the number of states in the underlying SimTK::Measure. More...

bool	isEnabled () const
	Returns true if the Probe is enabled and false if the probe is disabled. More...

void	setEnabled (bool enabled)
	Set the Probe as enabled (true) or disabled (false). More...

std::string	getOperation () const
	Return the operation being performed on the probe value. More...

void	setOperation (std::string probe_operation)
	Set the operation being performed on the probe value. More...

SimTK::Vector	getInitialConditions () const
	Return the initial conditions (when the probe_operation is set to 'integrate'). More...

void	setInitialConditions (SimTK::Vector initial_conditions_for_integration)
	Set the initial conditions (when the probe_operation is set to 'integrate'). More...

double	getGain () const
	Return the gain to apply to the probe output. More...

void	setGain (double gain)
	Set the gain to apply to the probe output. More...

SimTK::Vector	getProbeOutputs (const SimTK::State &state) const
	Returns the values of the probe after the operation has been performed. More...

void	updateFromXMLNode (SimTK::Xml::Element &node, int versionNumber) override
	Handle a change in XML syntax for Sockets. More...

const bool &	get_enabled () const
	Get the value of the enabled property. More...

bool &	upd_enabled ()
	Get a writable reference to the enabled property. More...

void	set_enabled (const bool &value)
	Set the value of the enabled property. More...

const std::string &	get_probe_operation () const
	Get the value of the probe_operation property. More...

std::string &	upd_probe_operation ()
	Get a writable reference to the probe_operation property. More...

void	set_probe_operation (const std::string &value)
	Set the value of the probe_operation property. More...

const double &	get_initial_conditions_for_integration (int i) const
	Get the value of the i-th element of the initial_conditions_for_integration property. More...

double &	upd_initial_conditions_for_integration (int i)
	Get a writable reference to the i-th element of the initial_conditions_for_integration property. More...

void	set_initial_conditions_for_integration (int i, const double &value)
	Set the value of the i-th element of initial_conditions_for_integration property. More...

int	append_initial_conditions_for_integration (const double &value)
	Append an element to the initial_conditions_for_integration property. More...

const double &	get_gain () const
	Get the value of the gain property. More...

double &	upd_gain ()
	Get a writable reference to the gain property. More...

void	set_gain (const double &value)
	Set the value of the gain property. More...

Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor. More...

	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct ModelComponent from an XML file. More...

	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document. More...

virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup. More...

void	connectToModel (Model &model)
	Connect this ModelComponent to its aggregate- a Model. More...

const Model &	getModel () const
	Get a const reference to the Model this component is part of. More...

Model &	updModel ()
	Get a modifiable reference to the Model this component is part of. More...

bool	hasModel () const
	Does this ModelComponent have a Model associated with it? More...

void	preScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model. More...

void	scale (const SimTK::State &s, const ScaleSet &scaleSet)
	Scale the ModelComponent. More...

void	postScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model. More...

Public Member Functions inherited from OpenSim::Component
	Component ()
	Default constructor. More...

	Component (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct Component from an XML file. More...

	Component (SimTK::Xml::Element &aNode)
	Construct Component from a specific node in an XML document. More...

	Component (const Component &)=default
	Use default copy constructor and assignment operator. More...

Component &	operator= (const Component &)=default

virtual	~Component ()=default
	Destructor is virtual to allow concrete Component to cleanup. More...

virtual void	generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
	Optional method for generating arbitrary display geometry that reflects this Component at the specified state. More...

const SimTK::MultibodySystem &	getSystem () const
	Get the underlying MultibodySystem that this component is connected to. More...

bool	hasSystem () const
	Check if this component has an underlying MultibodySystem. More...

bool	isComponentInOwnershipTree (const Component *component) const
	Does the provided component already exist anywhere in the ownership tree (not just subcomponents of this component)? More...

void	addComponent (Component *subcomponent)
	Add a Component (as a subcomponent) of this component. More...

template<typename T = Component>
ComponentList< const T >	getComponentList () const
	Get an iterator through the underlying subcomponents that this component is composed of. More...

template<typename T = Component>
ComponentList< T >	updComponentList ()
	Similar to getComponentList(), except the resulting list allows one to modify the components. More...

template<typename T = Component>
unsigned	countNumComponents () const
	Uses getComponentList<T>() to count the number of underlying subcomponents of the specified type. More...

std::string	getAbsolutePathString () const
	Get the complete (absolute) pathname for this Component to its ancestral Component, which is the root of the tree to which this Component belongs. More...

ComponentPath	getAbsolutePath () const
	Return a ComponentPath of the absolute path of this Component. More...

std::string	getRelativePathString (const Component &wrt) const
	Get the relative path of this Component with respect to another Component, as a string. More...

ComponentPath	getRelativePath (const Component &wrt) const
	Get the relative path of this Component with respect to another Component. More...

bool	hasComponent (const std::string &pathname) const
	Query if there is a component (of any type) at the specified path name. More...

template<class C = Component>
bool	hasComponent (const std::string &pathname) const
	Query if there is a component of a given type at the specified path name. More...

template<class C = Component>
const C &	getComponent (const std::string &pathname) const
	Get a unique subcomponent of this Component by its path name and type 'C'. More...

template<class C = Component>
const C &	getComponent (const ComponentPath &pathname) const

const Component &	getComponent (const std::string &pathname) const
	Similar to the templatized getComponent(), except this returns the component as the generic Component type. More...

template<class C = Component>
C &	updComponent (const std::string &name)
	Get a writable reference to a subcomponent. More...

template<class C = Component>
C &	updComponent (const ComponentPath &name)

Component &	updComponent (const std::string &pathname)
	Similar to the templatized updComponent(), except this returns the component as the generic Component type. More...

unsigned	printComponentsMatching (const std::string &substring) const
	Print a list to the console of all components whose absolute path name contains the given string. More...

int	getNumStateVariables () const
	Get the number of "continuous" state variables maintained by the Component and its subcomponents. More...

Array< std::string >	getStateVariableNames () const
	Get the names of "continuous" state variables maintained by the Component and its subcomponents. More...

template<class C = Component>
const C *	findComponent (const ComponentPath &pathToFind) const
	Find a Component to which this Component is an ancestor—in other words, a Component that is directly owned by this Component or is owned by one of its sub-components, sub-sub-components, etc. More...

template<class C = Component>
const C *	findComponent (const std::string &pathToFind) const
	Same as findComponent(const ComponentPath&), but accepting a string (a path or just a name) as input. More...

const StateVariable *	traverseToStateVariable (const std::string &pathName) const
	Get a StateVariable anywhere in the Component tree, given a StateVariable path. More...

void	finalizeFromProperties ()
	Define a Component's internal data members and structure according to its properties. More...

void	finalizeConnections (Component &root)
	Satisfy the Component's connections specified by its Sockets and Inputs. More...

void	clearConnections ()
	Disconnect/clear this Component from its aggregate component. More...

void	addToSystem (SimTK::MultibodySystem &system) const
	Have the Component add itself to the underlying computational System. More...

void	initStateFromProperties (SimTK::State &state) const
	Initialize Component's state variable values from its properties. More...

void	setPropertiesFromState (const SimTK::State &state)
	Set Component's properties given a state. More...

int	getNumSockets () const
	Get the number of Sockets in this Component. More...

std::vector< std::string >	getSocketNames ()
	Collect and return the names of the sockets in this component. More...

template<typename T >
const T &	getConnectee (const std::string &name) const
	Get the "connectee" object that the Component's Socket is bound to. More...

const Object &	getConnectee (const std::string &name) const
	Get the connectee as an Object. More...

const AbstractSocket &	getSocket (const std::string &name) const
	Get an AbstractSocket for the given socket name. More...

AbstractSocket &	updSocket (const std::string &name)
	Get a writable reference to the AbstractSocket for the given socket name. More...

template<typename T >
const Socket< T > &	getSocket (const std::string &name) const
	Get a const reference to the concrete Socket provided by this Component by name. More...

template<typename T >
Socket< T > &	updSocket (const std::string &name)
	Get a writable reference to the concrete Socket provided by this Component by name. More...

void	printSubcomponentInfo () const
	List all subcomponents by name and recurse into these components to list their subcomponents, and so on. More...

void	printSocketInfo () const
	List all the Sockets of this component and whether or not they are connected. More...

void	printInputInfo () const
	List all the inputs of this component and whether or not they are connected. More...

template<typename C >
void	printSubcomponentInfo () const

void	printOutputInfo (const bool includeDescendants=true) const
	Print outputs of this component and optionally, those of all subcomponents. More...

int	getNumInputs () const
	Access the number of Inputs that this component has. More...

int	getNumOutputs () const
	Access the number of Outputs that this component has. More...

std::vector< std::string >	getInputNames () const
	Collect and return the names of Inputs in this component as an std::vector. More...

std::vector< std::string >	getOutputNames () const
	Collect and return the names of Outputs in this component as an std::vector. More...

const AbstractInput &	getInput (const std::string &name) const
	Get an Input provided by this Component by name. More...

AbstractInput &	updInput (const std::string &name)
	Get a writable reference to an Input provided by this Component by name. More...

template<typename T >
const Input< T > &	getInput (const std::string &name) const
	Get a concrete Input that you can directly ask for its values. More...

const AbstractOutput &	getOutput (const std::string &name) const
	Get the Output provided by this Component by name. More...

AbstractOutput &	updOutput (const std::string &name)
	Get a writable reference to an Output provided by this Component by name. More...

SimTK::IteratorRange< OutputConstIterator >	getOutputs () const
	Iterate through all Outputs of this component. More...

int	getModelingOption (const SimTK::State &state, const std::string &name) const
	Get a ModelingOption flag for this Component by name. More...

void	setModelingOption (SimTK::State &state, const std::string &name, int flag) const
	Set the value of a ModelingOption flag for this Component. More...

template<typename T >
const T &	getInputValue (const SimTK::State &state, const std::string &name) const
	Get the Input value that this component is dependent on. More...

template<typename T >
const T &	getOutputValue (const SimTK::State &state, const std::string &name) const
	Get the Output value provided by this Component by name. More...

double	getStateVariableValue (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this Component. More...

void	setStateVariableValue (SimTK::State &state, const std::string &name, double value) const
	Set the value of a state variable allocated by this Component by name. More...

SimTK::Vector	getStateVariableValues (const SimTK::State &state) const
	Get all values of the state variables allocated by this Component. More...

void	setStateVariableValues (SimTK::State &state, const SimTK::Vector &values) const
	Set all values of the state variables allocated by this Component. More...

double	getStateVariableDerivativeValue (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable derivative computed by this Component. More...

double	getDiscreteVariableValue (const SimTK::State &state, const std::string &name) const
	Get the value of a discrete variable allocated by this Component by name. More...

void	setDiscreteVariableValue (SimTK::State &state, const std::string &name, double value) const
	Set the value of a discrete variable allocated by this Component by name. More...

template<class T >
SimTK::CacheEntryIndex	getCacheVariableIndex (const CacheVariable< T > &cv) const
	Get the index of a Component's cache variable in the Subsystem for allocations. More...

SimTK::CacheEntryIndex	getCacheVariableIndex (const std::string &name) const
	Get the index of a Component's cache variable in the Subsystem for allocations. More...

template<class T >
const T &	getCacheVariableValue (const SimTK::State &state, const std::string &name) const
	Get the value of a cache variable allocated by this Component by name. More...

template<class T >
const T &	getCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
	Get the value of a cache variable allocated by this Component. More...

template<typename T >
void	setCacheVariableValue (const SimTK::State &state, const std::string &k, T value) const
	Set the value of a cache variable, identified by `name`, to a new value and mark the cache variable as valid. More...

template<typename T >
void	setCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv, T value) const
	Set the value of a cache variable to a new value and mark the cache variable as valid. More...

template<typename T >
T &	updCacheVariableValue (const SimTK::State &state, const std::string &name) const
	Returns a mutable reference to the value of a cache variable identified by `name`. More...

template<typename T >
T &	updCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
	Returns a mutable reference to the value of a cache variable. More...

bool	isCacheVariableValid (const SimTK::State &state, const std::string &name) const
	Returns true if the cache variable, identified by `name`, is valid. More...

template<class T >
bool	isCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
	Returns true if the cache variable is valid. More...

void	markCacheVariableValid (const SimTK::State &state, const std::string &name) const
	Marks the value of a cache variable, identified by `name`, as valid. More...

template<typename T >
void	markCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
	Marks the value of a cache variable as valid. More...

void	markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
	Marks the value of a cache variable, identified by `name`, as invalid. More...

template<class T >
void	markCacheVariableInvalid (const SimTK::State &state, const CacheVariable< T > &cv) const
	Marks the value of a cache variable as invalid. More...

const Component &	getOwner () const
	Access the owner of this Component. More...

bool	hasOwner () const
	(For advanced users) Check if this Component has an owner. More...

const Component &	getRoot () const
	Obtain the root Component, which is this component if it is orphaned. More...

Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup. More...

bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading. More...

Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties. More...

virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal. More...

virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers. More...

void	setName (const std::string &name)
	Set the name of the Object. More...

const std::string &	getName () const
	Get the name of this Object. More...

void	setDescription (const std::string &description)
	Set description, a one-liner summary. More...

const std::string &	getDescription () const
	Get description, a one-liner summary. More...

const std::string &	getAuthors () const
	Get Authors of this Object. More...

void	setAuthors (const std::string &authors)
	Set Authors of this object. More...

const std::string &	getReferences () const
	Get references or publications to cite if using this object. More...

void	setReferences (const std::string &references)
	Set references or publications to cite if using this object. More...

int	getNumProperties () const
	Determine how many properties are stored with this Object. More...

const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty. More...

bool	hasProperty (const std::string &name) const
	Return true if this Object has a property of any type with the given name, which must not be empty. More...

const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty. More...

template<class T >
bool	hasProperty () const
	Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...

template<class T >
const Property< T > &	getProperty (const PropertyIndex &index) const
	Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...

template<class T >
Property< T > &	updProperty (const PropertyIndex &index)
	Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...

bool	isObjectUpToDateWithProperties () const
	Returns `true` if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...

void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object. More...

void	updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
	Serialize this object into the XML node that represents it. More...

bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument. More...

void	setInlined (bool aInlined, const std::string &aFileName="")
	Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...

std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document. More...

int	getDocumentFileVersion () const
	If there is a document associated with this object then return its version number. More...

void	setAllPropertiesUseDefault (bool aUseDefault)

bool	print (const std::string &fileName) const
	Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...

std::string	dump () const
	dump the XML representation of this Object into an std::string and return it. More...

virtual bool	isA (const char *type) const
	The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...

const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...

PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...

const PropertySet &	getPropertySet () const

Auto-generated functions
static Umberger2010MuscleMetabolicsProbe *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Umberger2010MuscleMetabolicsProbe". More...

Umberger2010MuscleMetabolicsProbe *	clone () const override
	Create a new heap-allocated copy of the concrete object to which this Object refers. More...

const std::string &	getConcreteClassName () const override
	Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...

Umberger2010MuscleMetabolicsProbe Interface
These accessor methods are to be used when setting up a new muscle metabolic analysis from the API. The basic operation is as follows: Umberger2010MuscleMetabolicsProbe* myProbe new Umberger2010MuscleMetabolicsProbe(...); model.addProbe(myProbe); myProbe->addMuscle("muscleName1", ... ); myProbe->addMuscle("muscleName2", ... ); myProbe->addMuscle("muscleName3", ... ); myProbe->useProvidedMass("muscleName1", 1.2); // muscle1 mass = 1.2 kg myProbe->useCalculatedMass("muscleName2"); // muscle2 mass is based on muscle properties (below) myProbe->setDensity("muscleName2", 1100.0); // muscle2 density is 1100 kg/m^3 myProbe->setSpecificTension("muscleName2", 0.26e6); // muscle2 specific tension is 0.26e6 Pa myProbe->removeMuscle("muscleName3"); myProbe->setOperation("integrate") // See OpenSim::Probe for other operations Note It is important to first add the metabolic probe to the model before calling any other methods that may modify its properties. This is because some methods (e.g. addMuscle() or useCalculatedMass) may require information about the muscles to successfully execute, and this information can only be obtained if the metabolic probe is already 'connected' to the model.
int	getNumMetabolicMuscles () const
	Get the number of muscles being analyzed in the metabolic analysis. More...

void	addMuscle (const std::string &muscleName, double ratio_slow_twitch_fibers)
	Add a muscle and its parameters so that it can be included in the metabolic analysis. More...

void	addMuscle (const std::string &muscleName, double ratio_slow_twitch_fibers, double muscle_mass)
	Add a muscle and its parameters so that it can be included in the metabolic analysis. More...

void	removeMuscle (const std::string &muscleName)
	Remove a muscle from the metabolic analysis. More...

void	useProvidedMass (const std::string &muscleName, double providedMass)
	Set an existing muscle to use a provided muscle mass. More...

void	useCalculatedMass (const std::string &muscleName)
	Set an existing muscle to calculate its own mass. More...

bool	isUsingProvidedMass (const std::string &muscleName)
	Get whether the muscle mass is being explicitly provided. More...

double	getMuscleMass (const std::string &muscleName) const
	Get the muscle mass used in the metabolic analysis. More...

double	getRatioSlowTwitchFibers (const std::string &muscleName) const
	Get the ratio of slow twitch fibers for an existing muscle. More...

void	setRatioSlowTwitchFibers (const std::string &muscleName, const double &ratio)
	Set the ratio of slow twitch fibers for an existing muscle. More...

double	getDensity (const std::string &muscleName) const
	Get the density for an existing muscle (kg/m^3). More...

void	setDensity (const std::string &muscleName, const double &density)
	Set the density for an existing muscle (kg/m^3). More...

double	getSpecificTension (const std::string &muscleName) const
	Get the specific tension for an existing muscle (Pascals (N/m^2)). More...

void	setSpecificTension (const std::string &muscleName, const double &specificTension)
	Set the specific tension for an existing muscle (Pascals (N/m^2)). More...

Additional Inherited Members
Static Public Member Functions inherited from OpenSim::Probe
static Probe *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Probe". More...

Static Public Member Functions inherited from OpenSim::ModelComponent
static ModelComponent *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "ModelComponent". More...

Static Public Member Functions inherited from OpenSim::Component
static Component *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Component". More...

Static Public Member Functions inherited from OpenSim::Object
static void	registerType (const Object &defaultObject)
	Register an instance of a class; if the class is already registered it will be replaced. More...

static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current Object type with an old name. More...

static const Object *	getDefaultInstanceOfType (const std::string &concreteClassName)
	Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...

template<class T >
static bool	isObjectTypeDerivedFrom (const std::string &concreteClassName)
	Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...

static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...

static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far. More...

template<class T >
static void	getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
	Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
	Same as the other signature but the class name and property name are provided as two separate strings. More...

static Object *	makeObjectFromFile (const std::string &fileName)
	Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...

static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object". More...

static void	setSerializeAllDefaults (bool shouldSerializeDefaults)
	Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...

static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag. More...

static bool	isKindOf (const char *type)
	Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...

static void	setDebugLevel (int newLevel)
	Set the amount of logging output. More...

static int	getDebugLevel ()
	Get the current setting of debug level. More...

static Object *	SafeCopy (const Object *aObject)
	Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...

static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType(). More...

static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType(). More...

Detailed Description

Umberger2010MuscleMetabolicsProbe is a Probe ModelComponent for computing the net metabolic energy rate of a set of Muscles in the model during a simulation.

Umberger2010MuscleMetabolicsProbe Theory

The discussion here is based on the following papers:

Uchida, T. K., Hicks, J. L., Dembia, C. L., Delp, S. L. (2016). Stretching your energetic budget: how tendon compliance affects the metabolic cost of running. PLOS ONE 11(3), e0150378.

Umberger, B. R. (2010). Stance and swing phase costs in human walking. J R Soc Interface 7, 1329-40.

Umberger, B. R., Gerritsen, K. G. and Martin, P. E. (2003). A model of human muscle energy expenditure. Comput Methods Biomech Biomed Engin 6, 99-111.

Note that the equations below that describe the particular implementation of Umberger2010MuscleMetabolicsProbe may slightly differ from the equations described in the representative publications above. Note also that we define positive muscle velocity to indicate lengthening (eccentric contraction) and negative muscle velocity to indicate shortening (concentric contraction).

Muscle metabolic power (or rate of metabolic energy consumption) is equal to the rate at which heat is liberated plus the rate at which work is done:
Edot = Bdot + sumOfAllMuscles(Adot + Mdot + Sdot + Wdot).

Bdot is the basal heat rate (W).
Adot is the activation heat rate (W).
Mdot is the maintenance heat rate (W).
Sdot is the shortening heat rate (W).
Wdot is the mechanical work rate (W).

This probe also uses muscle parameters stored in the MetabolicMuscle object for each muscle. The full set of all MetabolicMuscles (MetabolicMuscleSet) is a property of this probe:

m = The mass of the muscle (kg).
r = Ratio of slow-twitch fibers in the muscle (between 0 and 1).

The recruitment model described by Bhargava et al. (2004) is used to set the slow-twitch fiber ratio used in the calculations below. The ratio specified by the user indicates the composition of the muscle; this value is used only at full excitation (i.e., when all fibers are recruited). As excitation decreases from 1 to 0, the proportion of recruited fibers that are slow-twitch fibers increases from r to 1. See Bhargava, L.J., Pandy, M.G., Anderson, F.C. (2004) A phenomenological model for estimating metabolic energy consumption in muscle contraction. J Biomech 37:81-88 and Uchida et al. (2016). To assume a constant ratio of slow- and fast-twitch fiber recruitment, set the 'use_Bhargava_recruitment_model' property to false.

BASAL HEAT RATE (W)

If basal_rate_on is set to true, then Bdot is calculated as follows:
Bdot = basal_coefficient * (m_body^basal_exponent)

m_body = mass of the entire model
basal_coefficient and basal_exponent are defined by their respective properties.
Note that this quantity is muscle independent. Rather it is calculated on a whole body level.

ACTIVATION & MAINTENANCE HEAT RATE (W)

If activation_maintenance_rate_on is set to true, then Adot+Mdot is calculated as follows:
Adot+Mdot = [128*(1-r) + 25] * A^0.6 * S , l_CE <= l_CE_opt
Adot+Mdot = (0.4*[128*(1-r) + 25] + 0.6*[128*(1-r) + 25]*F_CE_iso) * A^0.6 * S , l_CE > l_CE_opt

A = u , u > a
A = (u+a)/2 , u <= a
m = The mass of the muscle (kg).
l_CE = muscle fiber length at the current time.
l_CE_opt = optimal fiber length of the muscle.
F_CE_iso = normalized contractile element force-length curve.
u = muscle excitation at the current time.
a = muscle activation at the current time.
S = aerobic/anaerobic scaling factor, defined by the 'aerobic_factor' property (i.e. usually 1.0 for primarily anaerobic activities, 1.5 for primarily aerobic activities).

SHORTENING HEAT RATE (W)

If shortening_rate_on is set to true, then Sdot is calculated as follows:
Sdot = m * (-[(alphaS_slow * v_CE_norm * r) + (alphaS_fast * v_CE_norm * (1-r))] * A^2 * S) , l_CE <= l_CE_opt & v_CE >= 0 (concentric / isometric contraction)
Sdot = m * (-[(alphaS_slow * v_CE_norm * r) + (alphaS_fast * v_CE_norm * (1-r))] * A^2 * S * F_iso) , l_CE > l_CE_opt & v_CE >= 0 (concentric / isometric contraction)
Sdot = m * (alphaL * v_CE_norm * A * S) , l_CE <= l_CE_opt & v_CE < 0 (eccentric contraction)
Sdot = m * (alphaL * v_CE_norm * A * S * F_CE_iso) , l_CE > l_CE_opt & v_CE < 0 (eccentric contraction)

A = u , u > a
A = (u+a)/2 , u <= a
alphaS_fast = 153 / v_CE_max
alphaS_slow = 100 / (v_CE_max / 2.5)
alphaL = 4.0 * alphaS_slow
m = The mass of the muscle (kg).
l_CE = muscle fiber length at the current time.
l_CE_opt = optimal fiber length of the muscle.
F_CE_iso = force that would be developed by the contractile element of muscle under isometric conditions with the current activation and fiber length.
v_CE = muscle fiber velocity at the current time.
v_CE_max = maximum shortening velocity of the muscle.
v_CE_norm = normalized muscle fiber velocity (defined for this model as v_CE/l_CE_opt). Note that this is a different metric to the typical normalized_muscle_fiber_velocity of v_CE/v_CE_max.
S = aerobic/anaerobic scaling factor, defined by the 'aerobic_factor' property (i.e. usually 1.0 for primarily anaerobic activities, 1.5 for primarily aerobic activities).

MECHANICAL WORK RATE (W)

If mechanical_work_rate_on is set to true, then Wdot is calculated as follows:
Wdot = -(F_CE * v_CE)

v_CE = muscle fiber velocity at the current time.
F_CE = force developed by the contractile element of muscle at the current time.
If we draw a control volume around the fiber, the first law of thermodynamics suggests that negative mechanical work should be included in Wdot. As such, we revert back to the model described in Umberger et al. (2003) by default. To exclude negative mechanical work from Wdot and use a coefficient of 0.3 (rather than 4.0) to calculate alpha_L, set the 'include_negative_mechanical_work' property to false.

During eccentric contraction, the magnitude of the (negative) mechanical work rate can exceed that of the total (positive) heat rate, resulting in a flow of energy into the fiber. Experiments indicate that the chemical processes involved in fiber contraction cannot be reversed, and most of the energy that is absorbed during eccentric contraction (in increased cross-bridge potentials, for example) is eventually converted into heat. Thus, we increase Sdot (if necessary) to ensure Edot > 0 for each muscle. See Constable, J.K., Barclay, C.J., Gibbs, C.L. (1997) Energetics of lengthening in mouse and toad skeletal muscles. J Physiol 505:205-215 and Uchida et al. (2016). To allow muscles to have negative total power, set the 'forbid_negative_total_power' property to false.

Note that if enforce_minimum_heat_rate_per_muscle == true AND activation_maintenance_rate_on == shortening_rate_on == true, then the total heat rate (AMdot + Sdot) will be capped to a minimum value of 1.0 W/kg (Umberger(2003), page 104).

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter is an Object class that holds the metabolic parameters required to calculate metabolic power for a single muscle.

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter Properties

REQUIRED PROPERTIES

specific_tension = The specific tension of the muscle (Pascals (N/m^2)).
density = The density of the muscle (kg/m^3).
ratio_slow_twitch_fibers = Ratio of slow twitch fibers in the muscle (must be between 0 and 1).

OPTIONAL PROPERTIES

use_provided_muscle_mass = An optional flag that allows the user to explicitly specify a muscle mass. If set to true, the 'provided_muscle_mass' property must be specified. The default setting is false, in which case, the muscle mass is calculated from the following formula: m = (Fmax/specific_tension)*density*Lm_opt, where specific_tension and density are properties defined above (note that their default values are set based on mammalian muscle, 0.25e6 N/m^2 and 1059.7 kg/m^3, respectively); Fmax and Lm_opt are the maximum isometric force and optimal fiber length, respectively, of the muscle.
provided_muscle_mass = The user specified muscle mass (kg).

Author: Tim Dorn

Examples:: exampleHangingMuscle.cpp.

Constructor & Destructor Documentation

◆ Umberger2010MuscleMetabolicsProbe() [1/2]

OpenSim::Umberger2010MuscleMetabolicsProbe::Umberger2010MuscleMetabolicsProbe ( )

Default constructor.

◆ Umberger2010MuscleMetabolicsProbe() [2/2]

OpenSim::Umberger2010MuscleMetabolicsProbe::Umberger2010MuscleMetabolicsProbe	(	const bool	activation_maintenance_rate_on,
		const bool	shortening_rate_on,
		const bool	basal_rate_on,
		const bool	work_rate_on
	)

Convenience constructor.

Member Typedef Documentation

◆ MuscleMap

typedef std::map<std::string, Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter*> OpenSim::Umberger2010MuscleMetabolicsProbe::MuscleMap

MuscleMap typedef.

Member Function Documentation

◆ addMuscle() [1/2]

void OpenSim::Umberger2010MuscleMetabolicsProbe::addMuscle	(	const std::string &	muscleName,
		double	ratio_slow_twitch_fibers
	)

Add a muscle and its parameters so that it can be included in the metabolic analysis.

◆ addMuscle() [2/2]

void OpenSim::Umberger2010MuscleMetabolicsProbe::addMuscle	(	const std::string &	muscleName,
		double	ratio_slow_twitch_fibers,
		double	muscle_mass
	)

Add a muscle and its parameters so that it can be included in the metabolic analysis.

◆ clone()

Umberger2010MuscleMetabolicsProbe* OpenSim::Umberger2010MuscleMetabolicsProbe::clone ( ) const

inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Probe.

◆ computeProbeInputs()

virtual SimTK::Vector OpenSim::Umberger2010MuscleMetabolicsProbe::computeProbeInputs ( const SimTK::State & state ) const

overridevirtual

Compute muscle metabolic power.

Implements OpenSim::Probe.

◆ get_activation_maintenance_rate_on()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_activation_maintenance_rate_on ( ) const

inline

Get the value of the activation_maintenance_rate_on property.

◆ get_aerobic_factor()

const double& OpenSim::Umberger2010MuscleMetabolicsProbe::get_aerobic_factor ( ) const

inline

Get the value of the aerobic_factor property.

◆ get_basal_coefficient()

const double& OpenSim::Umberger2010MuscleMetabolicsProbe::get_basal_coefficient ( ) const

inline

Get the value of the basal_coefficient property.

◆ get_basal_exponent()

const double& OpenSim::Umberger2010MuscleMetabolicsProbe::get_basal_exponent ( ) const

inline

Get the value of the basal_exponent property.

◆ get_basal_rate_on()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_basal_rate_on ( ) const

inline

Get the value of the basal_rate_on property.

◆ get_enforce_minimum_heat_rate_per_muscle()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_enforce_minimum_heat_rate_per_muscle ( ) const

inline

Get the value of the enforce_minimum_heat_rate_per_muscle property.

◆ get_forbid_negative_total_power()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_forbid_negative_total_power ( ) const

inline

Get the value of the forbid_negative_total_power property.

◆ get_include_negative_mechanical_work()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_include_negative_mechanical_work ( ) const

inline

Get the value of the include_negative_mechanical_work property.

◆ get_mechanical_work_rate_on()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_mechanical_work_rate_on ( ) const

inline

Get the value of the mechanical_work_rate_on property.

◆ get_muscle_effort_scaling_factor()

const double& OpenSim::Umberger2010MuscleMetabolicsProbe::get_muscle_effort_scaling_factor ( ) const

inline

Get the value of the muscle_effort_scaling_factor property.

◆ get_report_total_metabolics_only()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_report_total_metabolics_only ( ) const

inline

Get the value of the report_total_metabolics_only property.

◆ get_shortening_rate_on()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_shortening_rate_on ( ) const

inline

Get the value of the shortening_rate_on property.

◆ get_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

const Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet& OpenSim::Umberger2010MuscleMetabolicsProbe::get_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet ( ) const

inline

Get the value of the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property.

◆ get_use_Bhargava_recruitment_model()

const bool& OpenSim::Umberger2010MuscleMetabolicsProbe::get_use_Bhargava_recruitment_model ( ) const

inline

Get the value of the use_Bhargava_recruitment_model property.

◆ getClassName()

static const std::string& OpenSim::Umberger2010MuscleMetabolicsProbe::getClassName ( )

inlinestatic

This returns "Umberger2010MuscleMetabolicsProbe".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

◆ getConcreteClassName()

const std::string& OpenSim::Umberger2010MuscleMetabolicsProbe::getConcreteClassName ( ) const

inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also: getClassName()

Implements OpenSim::Probe.

◆ getDensity()

double OpenSim::Umberger2010MuscleMetabolicsProbe::getDensity ( const std::string & muscleName ) const

Get the density for an existing muscle (kg/m^3).

◆ getMuscleMass()

double OpenSim::Umberger2010MuscleMetabolicsProbe::getMuscleMass ( const std::string & muscleName ) const

Get the muscle mass used in the metabolic analysis.

The value returned will depend on if the muscle mass is explicitly provided (i.e. isUsingProvidedMass = true), or if it is being automatically calculated from muscle data already present in the model (i.e. isUsingProvidedMass = true).

◆ getNumMetabolicMuscles()

int OpenSim::Umberger2010MuscleMetabolicsProbe::getNumMetabolicMuscles ( ) const

Get the number of muscles being analyzed in the metabolic analysis.

◆ getNumProbeInputs()

int OpenSim::Umberger2010MuscleMetabolicsProbe::getNumProbeInputs ( ) const

overridevirtual

Returns the number of probe inputs in the vector returned by computeProbeInputs().

Implements OpenSim::Probe.

◆ getProbeOutputLabels()

virtual OpenSim::Array<std::string> OpenSim::Umberger2010MuscleMetabolicsProbe::getProbeOutputLabels ( ) const

overridevirtual

Returns the column labels of the probe values for reporting.

Currently uses the Probe name as the column label, so be sure to name your probe appropriately!

Implements OpenSim::Probe.

◆ getRatioSlowTwitchFibers()

double OpenSim::Umberger2010MuscleMetabolicsProbe::getRatioSlowTwitchFibers ( const std::string & muscleName ) const

Get the ratio of slow twitch fibers for an existing muscle.

◆ getSpecificTension()

double OpenSim::Umberger2010MuscleMetabolicsProbe::getSpecificTension ( const std::string & muscleName ) const

Get the specific tension for an existing muscle (Pascals (N/m^2)).

◆ isUsingProvidedMass()

bool OpenSim::Umberger2010MuscleMetabolicsProbe::isUsingProvidedMass ( const std::string & muscleName )

Get whether the muscle mass is being explicitly provided.

True means that it is using the property 'provided_muscle_mass' False means that the muscle mass is being calculated from muscle properties.

◆ removeMuscle()

void OpenSim::Umberger2010MuscleMetabolicsProbe::removeMuscle ( const std::string & muscleName )

Remove a muscle from the metabolic analysis.

◆ safeDownCast()

static Umberger2010MuscleMetabolicsProbe* OpenSim::Umberger2010MuscleMetabolicsProbe::safeDownCast ( OpenSim::Object * obj )

inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = Umberger2010MuscleMetabolicsProbe.safeDownCast(obj). This is equivalent to dynamic_cast<Umberger2010MuscleMetabolicsProbe*>(obj) in C++.

◆ set_activation_maintenance_rate_on()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_activation_maintenance_rate_on ( const bool & value )

inline

Set the value of the activation_maintenance_rate_on property.

◆ set_aerobic_factor()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_aerobic_factor ( const double & value )

inline

Set the value of the aerobic_factor property.

◆ set_basal_coefficient()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_basal_coefficient ( const double & value )

inline

Set the value of the basal_coefficient property.

◆ set_basal_exponent()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_basal_exponent ( const double & value )

inline

Set the value of the basal_exponent property.

◆ set_basal_rate_on()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_basal_rate_on ( const bool & value )

inline

Set the value of the basal_rate_on property.

◆ set_enforce_minimum_heat_rate_per_muscle()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_enforce_minimum_heat_rate_per_muscle ( const bool & value )

inline

Set the value of the enforce_minimum_heat_rate_per_muscle property.

◆ set_forbid_negative_total_power()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_forbid_negative_total_power ( const bool & value )

inline

Set the value of the forbid_negative_total_power property.

◆ set_include_negative_mechanical_work()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_include_negative_mechanical_work ( const bool & value )

inline

Set the value of the include_negative_mechanical_work property.

◆ set_mechanical_work_rate_on()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_mechanical_work_rate_on ( const bool & value )

inline

Set the value of the mechanical_work_rate_on property.

◆ set_muscle_effort_scaling_factor()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_muscle_effort_scaling_factor ( const double & value )

inline

Set the value of the muscle_effort_scaling_factor property.

◆ set_report_total_metabolics_only()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_report_total_metabolics_only ( const bool & value )

inline

Set the value of the report_total_metabolics_only property.

◆ set_shortening_rate_on()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_shortening_rate_on ( const bool & value )

inline

Set the value of the shortening_rate_on property.

◆ set_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet ( const Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet & value )

inline

Set the value of the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property.

◆ set_use_Bhargava_recruitment_model()

void OpenSim::Umberger2010MuscleMetabolicsProbe::set_use_Bhargava_recruitment_model ( const bool & value )

inline

Set the value of the use_Bhargava_recruitment_model property.

◆ setDensity()

void OpenSim::Umberger2010MuscleMetabolicsProbe::setDensity	(	const std::string &	muscleName,
		const double &	density
	)

Set the density for an existing muscle (kg/m^3).

◆ setRatioSlowTwitchFibers()

void OpenSim::Umberger2010MuscleMetabolicsProbe::setRatioSlowTwitchFibers	(	const std::string &	muscleName,
		const double &	ratio
	)

Set the ratio of slow twitch fibers for an existing muscle.

◆ setSpecificTension()

void OpenSim::Umberger2010MuscleMetabolicsProbe::setSpecificTension	(	const std::string &	muscleName,
		const double &	specificTension
	)

Set the specific tension for an existing muscle (Pascals (N/m^2)).

◆ upd_activation_maintenance_rate_on()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_activation_maintenance_rate_on ( )

inline

Get a writable reference to the activation_maintenance_rate_on property.

◆ upd_aerobic_factor()

double& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_aerobic_factor ( )

inline

Get a writable reference to the aerobic_factor property.

◆ upd_basal_coefficient()

double& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_basal_coefficient ( )

inline

Get a writable reference to the basal_coefficient property.

◆ upd_basal_exponent()

double& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_basal_exponent ( )

inline

Get a writable reference to the basal_exponent property.

◆ upd_basal_rate_on()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_basal_rate_on ( )

inline

Get a writable reference to the basal_rate_on property.

◆ upd_enforce_minimum_heat_rate_per_muscle()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_enforce_minimum_heat_rate_per_muscle ( )

inline

Get a writable reference to the enforce_minimum_heat_rate_per_muscle property.

◆ upd_forbid_negative_total_power()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_forbid_negative_total_power ( )

inline

Get a writable reference to the forbid_negative_total_power property.

◆ upd_include_negative_mechanical_work()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_include_negative_mechanical_work ( )

inline

Get a writable reference to the include_negative_mechanical_work property.

◆ upd_mechanical_work_rate_on()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_mechanical_work_rate_on ( )

inline

Get a writable reference to the mechanical_work_rate_on property.

◆ upd_muscle_effort_scaling_factor()

double& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_muscle_effort_scaling_factor ( )

inline

Get a writable reference to the muscle_effort_scaling_factor property.

◆ upd_report_total_metabolics_only()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_report_total_metabolics_only ( )

inline

Get a writable reference to the report_total_metabolics_only property.

◆ upd_shortening_rate_on()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_shortening_rate_on ( )

inline

Get a writable reference to the shortening_rate_on property.

◆ upd_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet ( )

inline

Get a writable reference to the Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet property.

◆ upd_use_Bhargava_recruitment_model()

bool& OpenSim::Umberger2010MuscleMetabolicsProbe::upd_use_Bhargava_recruitment_model ( )

inline

Get a writable reference to the use_Bhargava_recruitment_model property.

◆ useCalculatedMass()

void OpenSim::Umberger2010MuscleMetabolicsProbe::useCalculatedMass ( const std::string & muscleName )

Set an existing muscle to calculate its own mass.

◆ useProvidedMass()

void OpenSim::Umberger2010MuscleMetabolicsProbe::useProvidedMass	(	const std::string &	muscleName,
		double	providedMass
	)

Set an existing muscle to use a provided muscle mass.

OpenSim Property, Socket, Output, Input Documentation

◆ activation_maintenance_rate_on

bool OpenSim::Umberger2010MuscleMetabolicsProbe::activation_maintenance_rate_on

"Specify whether activation & maintenance heat rate is to be calculated (true/false)."

This property appears in XML files under the tag <activation_maintenance_rate_on>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_activation_maintenance_rate_on(), upd_activation_maintenance_rate_on(), set_activation_maintenance_rate_on()

◆ aerobic_factor

double OpenSim::Umberger2010MuscleMetabolicsProbe::aerobic_factor

"Aerobic scale factor (S=1.0 for primarily anaerobic conditions and S=1.5 " "for primarily aerobic conditions. See Umberger et al., (2003)."

This property appears in XML files under the tag <aerobic_factor>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_aerobic_factor(), upd_aerobic_factor(), set_aerobic_factor()

◆ basal_coefficient

double OpenSim::Umberger2010MuscleMetabolicsProbe::basal_coefficient

"Basal metabolic coefficient."

This property appears in XML files under the tag <basal_coefficient>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_basal_coefficient(), upd_basal_coefficient(), set_basal_coefficient()

◆ basal_exponent

double OpenSim::Umberger2010MuscleMetabolicsProbe::basal_exponent

"Basal metabolic exponent."

This property appears in XML files under the tag <basal_exponent>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_basal_exponent(), upd_basal_exponent(), set_basal_exponent()

◆ basal_rate_on

bool OpenSim::Umberger2010MuscleMetabolicsProbe::basal_rate_on

"Specify whether basal heat rate is to be calculated (true/false)."

This property appears in XML files under the tag <basal_rate_on>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_basal_rate_on(), upd_basal_rate_on(), set_basal_rate_on()

◆ enforce_minimum_heat_rate_per_muscle

bool OpenSim::Umberger2010MuscleMetabolicsProbe::enforce_minimum_heat_rate_per_muscle

"Specify whether the total heat rate for a muscle will be clamped to a " "minimum value of 1.0 W/kg (true/false)."

This property appears in XML files under the tag <enforce_minimum_heat_rate_per_muscle>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_enforce_minimum_heat_rate_per_muscle(), upd_enforce_minimum_heat_rate_per_muscle(), set_enforce_minimum_heat_rate_per_muscle()

◆ forbid_negative_total_power

bool OpenSim::Umberger2010MuscleMetabolicsProbe::forbid_negative_total_power

"Specify whether the total power for each muscle must remain positive " "(true/false). Disable to use the model as published in Umberger " "(2010)."

This property appears in XML files under the tag <forbid_negative_total_power>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_forbid_negative_total_power(), upd_forbid_negative_total_power(), set_forbid_negative_total_power()

◆ include_negative_mechanical_work

bool OpenSim::Umberger2010MuscleMetabolicsProbe::include_negative_mechanical_work

"Specify whether negative mechanical work will be included in Wdot and " "a coefficient of 4.0 will be used to calculate alpha_L (true/false). " "Disable to use the model as published in Umberger (2010)."

This property appears in XML files under the tag <include_negative_mechanical_work>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_include_negative_mechanical_work(), upd_include_negative_mechanical_work(), set_include_negative_mechanical_work()

◆ mechanical_work_rate_on

bool OpenSim::Umberger2010MuscleMetabolicsProbe::mechanical_work_rate_on

"Specify whether mechanical work rate is to be calculated (true/false)."

This property appears in XML files under the tag <mechanical_work_rate_on>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_mechanical_work_rate_on(), upd_mechanical_work_rate_on(), set_mechanical_work_rate_on()

◆ muscle_effort_scaling_factor

double OpenSim::Umberger2010MuscleMetabolicsProbe::muscle_effort_scaling_factor

"Scale the excitation and activation values used by the probe to " "compensate for solutions with excessive coactivation (e.g., when a " "suboptimal tracking strategy is used)."

This property appears in XML files under the tag <muscle_effort_scaling_factor>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_muscle_effort_scaling_factor(), upd_muscle_effort_scaling_factor(), set_muscle_effort_scaling_factor()

◆ report_total_metabolics_only

bool OpenSim::Umberger2010MuscleMetabolicsProbe::report_total_metabolics_only

"If set to false, the individual muscle metabolics, basal rate, and " "total summation will be reported. If set to true, only the total " "summation will be reported."

This property appears in XML files under the tag <report_total_metabolics_only>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_report_total_metabolics_only(), upd_report_total_metabolics_only(), set_report_total_metabolics_only()

◆ shortening_rate_on

bool OpenSim::Umberger2010MuscleMetabolicsProbe::shortening_rate_on

"Specify whether shortening heat rate is to be calculated (true/false)."

This property appears in XML files under the tag <shortening_rate_on>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_shortening_rate_on(), upd_shortening_rate_on(), set_shortening_rate_on()

◆ Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet OpenSim::Umberger2010MuscleMetabolicsProbe::Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet

"A set containing, for each muscle, the parameters " "required to calculate muscle metabolic power."

This property appears in XML files under the tag <Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet>. This property was generated with the OpenSim_DECLARE_UNNAMED_PROPERTY macro; see Property to learn about the property system.

See also: get_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet(), upd_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet(), set_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

◆ use_Bhargava_recruitment_model

bool OpenSim::Umberger2010MuscleMetabolicsProbe::use_Bhargava_recruitment_model

"Specify whether the recruitment model described by Bhargava et al. " "(2004) will used to determine the slow-twitch fiber ratio " "(true/false). Disable to use the model as published in Umberger " "(2010)."

This property appears in XML files under the tag <use_Bhargava_recruitment_model>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_use_Bhargava_recruitment_model(), upd_use_Bhargava_recruitment_model(), set_use_Bhargava_recruitment_model()

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

OpenSim/Simulation/Model/Umberger2010MuscleMetabolicsProbe.h

OpenSim Properties, Sockets, Outputs, Inputs

Public Member Functions

Auto-generated functions

Umberger2010MuscleMetabolicsProbe Interface

Additional Inherited Members

Detailed Description

Umberger2010MuscleMetabolicsProbe Theory

BASAL HEAT RATE (W)

ACTIVATION & MAINTENANCE HEAT RATE (W)

SHORTENING HEAT RATE (W)

MECHANICAL WORK RATE (W)

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter

Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter Properties

Constructor & Destructor Documentation

◆ Umberger2010MuscleMetabolicsProbe() [1/2]

◆ Umberger2010MuscleMetabolicsProbe() [2/2]

Member Typedef Documentation

◆ MuscleMap

Member Function Documentation

◆ addMuscle() [1/2]

◆ addMuscle() [2/2]

◆ clone()

◆ computeProbeInputs()

◆ get_activation_maintenance_rate_on()

◆ get_aerobic_factor()

◆ get_basal_coefficient()

◆ get_basal_exponent()

◆ get_basal_rate_on()

◆ get_enforce_minimum_heat_rate_per_muscle()

◆ get_forbid_negative_total_power()

◆ get_include_negative_mechanical_work()

◆ get_mechanical_work_rate_on()

◆ get_muscle_effort_scaling_factor()

◆ get_report_total_metabolics_only()

◆ get_shortening_rate_on()

◆ get_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

◆ get_use_Bhargava_recruitment_model()

◆ getClassName()

◆ getConcreteClassName()

◆ getDensity()

◆ getMuscleMass()

◆ getNumMetabolicMuscles()

◆ getNumProbeInputs()

◆ getProbeOutputLabels()

◆ getRatioSlowTwitchFibers()

◆ getSpecificTension()

◆ isUsingProvidedMass()

◆ removeMuscle()

◆ safeDownCast()

◆ set_activation_maintenance_rate_on()

◆ set_aerobic_factor()

◆ set_basal_coefficient()

◆ set_basal_exponent()

◆ set_basal_rate_on()

◆ set_enforce_minimum_heat_rate_per_muscle()

◆ set_forbid_negative_total_power()

◆ set_include_negative_mechanical_work()

◆ set_mechanical_work_rate_on()

◆ set_muscle_effort_scaling_factor()

◆ set_report_total_metabolics_only()

◆ set_shortening_rate_on()

◆ set_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

◆ set_use_Bhargava_recruitment_model()

◆ setDensity()

◆ setRatioSlowTwitchFibers()

◆ setSpecificTension()

◆ upd_activation_maintenance_rate_on()

◆ upd_aerobic_factor()

◆ upd_basal_coefficient()

◆ upd_basal_exponent()

◆ upd_basal_rate_on()

◆ upd_enforce_minimum_heat_rate_per_muscle()

◆ upd_forbid_negative_total_power()

◆ upd_include_negative_mechanical_work()

◆ upd_mechanical_work_rate_on()

◆ upd_muscle_effort_scaling_factor()

◆ upd_report_total_metabolics_only()

◆ upd_shortening_rate_on()

◆ upd_Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameterSet()

◆ upd_use_Bhargava_recruitment_model()