API  4.2
For MATLAB, Python, Java, and C++ users
OpenSim::Delp1990Muscle_Deprecated Class Reference

A class implementing a SIMM muscle. More...

+ Inheritance diagram for OpenSim::Delp1990Muscle_Deprecated:

Public Member Functions

 Delp1990Muscle_Deprecated ()
 
 Delp1990Muscle_Deprecated (const std::string &aName, double aMaxIsometricForce, double aOptimalFiberLength, double aTendonSlackLength, double aPennationAngle)
 
 Delp1990Muscle_Deprecated (const Delp1990Muscle_Deprecated &aMuscle)
 
virtual ~Delp1990Muscle_Deprecated ()
 
Delp1990Muscle_Deprecatedoperator= (const Delp1990Muscle_Deprecated &aMuscle)
 
void copyData (const Delp1990Muscle_Deprecated &aMuscle)
 
virtual double getTimeScale () const
 
virtual double getMass () const
 
virtual bool setTimeScale (double aTimeScale)
 
virtual bool setActivation1 (double aActivation1)
 
virtual bool setActivation2 (double aActivation2)
 
virtual bool setMass (double aMass)
 
virtual double getFiberVelocity (const SimTK::State &s) const
 
virtual void setFiberVelocity (SimTK::State &s, double fiberVelocity) const
 
virtual double getFiberVelocityDeriv (const SimTK::State &s) const
 
virtual void setFiberVelocityDeriv (const SimTK::State &s, double fiberVelocityDeriv) const
 
virtual void setActiveForce (const SimTK::State &s, double aForce) const
 
virtual double getActiveForce (const SimTK::State &s) const
 
double computeActuation (const SimTK::State &s) const override
 
double computeIsometricForce (SimTK::State &s, double activation) const override
 
virtual FunctiongetActiveForceLengthCurve () const
 
virtual bool setActiveForceLengthCurve (Function *aActiveForceLengthCurve)
 
virtual FunctiongetPassiveForceLengthCurve () const
 
virtual bool setPassiveForceLengthCurve (Function *aPassiveForceLengthCurve)
 
virtual FunctiongetTendonForceLengthCurve () const
 
virtual bool setTendonForceLengthCurve (Function *aTendonForceLengthCurve)
 
virtual FunctiongetForceVelocityCurve () const
 
virtual bool setForceVelocityCurve (Function *aForceVelocityCurve)
 
- Public Member Functions inherited from OpenSim::ActivationFiberLengthMuscle_Deprecated
 ActivationFiberLengthMuscle_Deprecated ()
 
virtual double getDefaultActivation () const
 
virtual void setDefaultActivation (double activation)
 
virtual double getDefaultFiberLength () const
 
virtual void setDefaultFiberLength (double length)
 
virtual double getFiberLength (const SimTK::State &s) const
 
virtual void setFiberLength (SimTK::State &s, double fiberLength) const
 
virtual double getFiberLengthDeriv (const SimTK::State &s) const
 
virtual void setFiberLengthDeriv (const SimTK::State &s, double fiberLengthDeriv) const
 
virtual double getNormalizedFiberLength (const SimTK::State &s) const
 
virtual double getFiberLengthAlongTendon (const SimTK::State &s) const
 
virtual double getTendonLength (const SimTK::State &s) const
 
virtual double getFiberForce (const SimTK::State &s) const
 
virtual double getActiveFiberForce (const SimTK::State &s) const
 
virtual double getPassiveFiberForce (const SimTK::State &s) const
 
virtual double getActiveFiberForceAlongTendon (const SimTK::State &s) const
 
virtual double getPassiveFiberForceAlongTendon (const SimTK::State &s) const
 
virtual double getPassiveForce (const SimTK::State &s) const
 
virtual void setPassiveForce (const SimTK::State &s, double aForce) const
 
virtual double getTendonForce (const SimTK::State &s) const
 
virtual void setTendonForce (const SimTK::State &s, double aForce) const
 
double getActivation (const SimTK::State &s) const override
 
void setActivation (SimTK::State &s, double activation) const override
 
virtual double getActivationDeriv (const SimTK::State &s) const
 
virtual void setActivationDeriv (const SimTK::State &s, double activationDeriv) const
 
virtual double getExcitation (const SimTK::State &s) const
 
double getStress (const SimTK::State &s) const override
 
void computeInitialFiberEquilibrium (SimTK::State &s) const override
 
double calcInextensibleTendonActiveFiberForce (SimTK::State &s, double aActivation) const override
 
virtual double evaluateForceLengthVelocityCurve (double aActivation, double aNormalizedLength, double aNormalizedVelocity) const
 
virtual double calcPennation (double aFiberLength, double aOptimalFiberLength, double aInitialPennationAngle) const
 
void extendPostScale (const SimTK::State &s, const ScaleSet &scaleSet) override
 Adjust the properties of the muscle after the model has been scaled. More...
 
- Public Member Functions inherited from OpenSim::Muscle
- Public Member Functions inherited from OpenSim::PathActuator
PathActuatorclone () 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...
 
- Public Member Functions inherited from OpenSim::ScalarActuator
- Public Member Functions inherited from OpenSim::Actuator
- Public Member Functions inherited from OpenSim::Force
- 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 ModelgetModel () const
 Get a const reference to the Model this component is part of. More...
 
ModelupdModel ()
 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
- 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...
 
Objectoperator= (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 AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (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 AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (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...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Static Public Member Functions

Auto-generated functions
static Delp1990Muscle_DeprecatedsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
- Static Public Member Functions inherited from OpenSim::ActivationFiberLengthMuscle_Deprecated
static ActivationFiberLengthMuscle_DeprecatedsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "ActivationFiberLengthMuscle_Deprecated"
More...
 
- Static Public Member Functions inherited from OpenSim::Muscle
static MusclesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Muscle"
More...
 
- Static Public Member Functions inherited from OpenSim::PathActuator
static PathActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "PathActuator"
More...
 
- Static Public Member Functions inherited from OpenSim::ScalarActuator
static ScalarActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "ScalarActuator"
More...
 
- Static Public Member Functions inherited from OpenSim::Actuator
static ActuatorsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Actuator"
More...
 
- Static Public Member Functions inherited from OpenSim::Force
static ForcesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Force"
More...
 
- Static Public Member Functions inherited from OpenSim::ModelComponent
static ModelComponentsafeDownCast (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 ComponentsafeDownCast (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 ObjectgetDefaultInstanceOfType (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 ObjectnewInstanceOfType (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 ObjectmakeObjectFromFile (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 ObjectSafeCopy (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...
 

Auto-generated functions <br>

static const std::string & getClassName ()
 This returns "Delp1990Muscle_Deprecated"
More...
 
Delp1990Muscle_Deprecatedclone () 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...
 

Detailed Description

A class implementing a SIMM muscle.

This implementation is based on muscle model 2 from the Dynamics Pipeline, but is modified slightly so that when fiber_velocity = 0.0, this model calculates lengths and forces that match SIMM's isometric calculations.

Author
Peter Loan
Version
1.0

Constructor & Destructor Documentation

◆ Delp1990Muscle_Deprecated() [1/3]

OpenSim::Delp1990Muscle_Deprecated::Delp1990Muscle_Deprecated ( )

◆ Delp1990Muscle_Deprecated() [2/3]

OpenSim::Delp1990Muscle_Deprecated::Delp1990Muscle_Deprecated ( const std::string &  aName,
double  aMaxIsometricForce,
double  aOptimalFiberLength,
double  aTendonSlackLength,
double  aPennationAngle 
)

◆ Delp1990Muscle_Deprecated() [3/3]

OpenSim::Delp1990Muscle_Deprecated::Delp1990Muscle_Deprecated ( const Delp1990Muscle_Deprecated aMuscle)

◆ ~Delp1990Muscle_Deprecated()

virtual OpenSim::Delp1990Muscle_Deprecated::~Delp1990Muscle_Deprecated ( )
virtual

Member Function Documentation

◆ clone()

Delp1990Muscle_Deprecated* OpenSim::Delp1990Muscle_Deprecated::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::ActivationFiberLengthMuscle_Deprecated.

◆ computeActuation()

double OpenSim::Delp1990Muscle_Deprecated::computeActuation ( const SimTK::State &  s) const
overridevirtual

◆ computeIsometricForce()

double OpenSim::Delp1990Muscle_Deprecated::computeIsometricForce ( SimTK::State &  s,
double  activation 
) const
overridevirtual

◆ computeStateVariableDerivatives()

void OpenSim::Delp1990Muscle_Deprecated::computeStateVariableDerivatives ( const SimTK::State &  s) const
overrideprotected

◆ copyData()

void OpenSim::Delp1990Muscle_Deprecated::copyData ( const Delp1990Muscle_Deprecated aMuscle)

◆ extendAddToSystem()

void OpenSim::Delp1990Muscle_Deprecated::extendAddToSystem ( SimTK::MultibodySystem &  system) const
overrideprotected

◆ extendConnectToModel()

void OpenSim::Delp1990Muscle_Deprecated::extendConnectToModel ( Model model)
overrideprotectedvirtual

Perform any necessary initializations required to connect the component into the Model, and check for error conditions.

extendConnectToModel() is invoked on all components to complete construction of a Model, prior to creating a Simbody System to represent it computationally. It may also be invoked at times just for its error-checking side effects.

If you override this method, be sure to invoke the base class method first, using code like this:

void MyComponent::extendConnectToModel(Model& model) {
Super::extendConnectToModel(model); // invoke parent class method
// ... your code goes here
}

Note that this method is expected to check for modeling errors and should throw an OpenSim::Exception if there is something wrong. For example, if your model component references another object by name, you should verify that it exists in the supplied Model, which is not guaranteed since components may be independently instantiated or constructed from XML files.

Parameters
[in,out]modelThe Model currently being constructed to which this ModelComponent should be connected.

Reimplemented from OpenSim::ModelComponent.

◆ getActiveForce()

virtual double OpenSim::Delp1990Muscle_Deprecated::getActiveForce ( const SimTK::State &  s) const
virtual

◆ getActiveForceLengthCurve()

virtual Function* OpenSim::Delp1990Muscle_Deprecated::getActiveForceLengthCurve ( ) const
virtual

◆ getClassName()

static const std::string& OpenSim::Delp1990Muscle_Deprecated::getClassName ( )
inlinestatic

This returns "Delp1990Muscle_Deprecated"

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

◆ getConcreteClassName()

const std::string& OpenSim::Delp1990Muscle_Deprecated::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::ActivationFiberLengthMuscle_Deprecated.

◆ getFiberVelocity()

virtual double OpenSim::Delp1990Muscle_Deprecated::getFiberVelocity ( const SimTK::State &  s) const
inlinevirtual

◆ getFiberVelocityDeriv()

virtual double OpenSim::Delp1990Muscle_Deprecated::getFiberVelocityDeriv ( const SimTK::State &  s) const
inlinevirtual

◆ getForceVelocityCurve()

virtual Function* OpenSim::Delp1990Muscle_Deprecated::getForceVelocityCurve ( ) const
virtual

◆ getMass()

virtual double OpenSim::Delp1990Muscle_Deprecated::getMass ( ) const
inlinevirtual

◆ getPassiveForceLengthCurve()

virtual Function* OpenSim::Delp1990Muscle_Deprecated::getPassiveForceLengthCurve ( ) const
virtual

◆ getTendonForceLengthCurve()

virtual Function* OpenSim::Delp1990Muscle_Deprecated::getTendonForceLengthCurve ( ) const
virtual

◆ getTimeScale()

virtual double OpenSim::Delp1990Muscle_Deprecated::getTimeScale ( ) const
inlinevirtual

◆ operator=()

Delp1990Muscle_Deprecated& OpenSim::Delp1990Muscle_Deprecated::operator= ( const Delp1990Muscle_Deprecated aMuscle)

◆ safeDownCast()

static Delp1990Muscle_Deprecated* OpenSim::Delp1990Muscle_Deprecated::safeDownCast ( OpenSim::Object obj)
inlinestatic

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

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

◆ setActivation1()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setActivation1 ( double  aActivation1)
virtual

◆ setActivation2()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setActivation2 ( double  aActivation2)
virtual

◆ setActiveForce()

virtual void OpenSim::Delp1990Muscle_Deprecated::setActiveForce ( const SimTK::State &  s,
double  aForce 
) const
virtual

◆ setActiveForceLengthCurve()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setActiveForceLengthCurve ( Function aActiveForceLengthCurve)
virtual

◆ setFiberVelocity()

virtual void OpenSim::Delp1990Muscle_Deprecated::setFiberVelocity ( SimTK::State &  s,
double  fiberVelocity 
) const
inlinevirtual

◆ setFiberVelocityDeriv()

virtual void OpenSim::Delp1990Muscle_Deprecated::setFiberVelocityDeriv ( const SimTK::State &  s,
double  fiberVelocityDeriv 
) const
inlinevirtual

◆ setForceVelocityCurve()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setForceVelocityCurve ( Function aForceVelocityCurve)
virtual

◆ setMass()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setMass ( double  aMass)
virtual

◆ setPassiveForceLengthCurve()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setPassiveForceLengthCurve ( Function aPassiveForceLengthCurve)
virtual

◆ setTendonForceLengthCurve()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setTendonForceLengthCurve ( Function aTendonForceLengthCurve)
virtual

◆ setTimeScale()

virtual bool OpenSim::Delp1990Muscle_Deprecated::setTimeScale ( double  aTimeScale)
virtual

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