Hill3ElemMuscleRigidTendon (Artisynth API documentation)

java.lang.Object
- artisynth.core.materials.MaterialBase
- - artisynth.core.materials.AxialMaterial
  - - artisynth.core.materials.Hill3ElemMuscleRigidTendon

All Implemented Interfaces:

HasMaterialState, PostScannable, ScalableUnits, java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable
```
public class Hill3ElemMuscleRigidTendon
extends AxialMaterial
```

Field Summary

Fields
Modifier and Type	Field and Description
`static CubicHermiteSpline1d`	`activForceLengthCurve`
`static double`	`DEFAULT_DAMPING`
`static double`	`DEFAULT_FORCE_SCALING`
`static double`	`DEFAULT_MAX_FORCE`
`static double`	`DEFAULT_OPT_FIBRE_LENGTH`
`static double`	`DEFAULT_PENNATION_ANGLE`
`static double`	`DEFAULT_TENDON_SLACK_LENGTH`
`static PropertyList`	`myProps`
`static CubicHermiteSpline1d`	`passivForceLengthCurve`

Constructor Summary

Constructors
Constructor and Description
`Hill3ElemMuscleRigidTendon()`
`Hill3ElemMuscleRigidTendon(double maxIsoForce, double optimalFibreLen, double tendonSlackLen, double penAngle)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Hill3ElemMuscleRigidTendon`	`clone()` Returns a clone of this composite property.
`double`	`computeDFdl(double l, double ldot, double l0, double excitation)` Computes and returns the derivative of the axial spring tension with respect to the length.
`double`	`computeDFdldot(double l, double ldot, double l0, double excitation)` Computes and returns the derivative of the axial spring tension with respect to the length time derivative.
`double`	`computeF(double l, double ldot, double l0, double excitation)` Computes and returns the axial spring tension, as a function of length, length time derivative, rest length, and excitation.
`boolean`	`equals(AxialMaterial mat)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getDamping()`
`PropertyMode`	`getDampingMode()`
`double`	`getForceScaling()`
`PropertyMode`	`getForceScalingMode()`
`double`	`getMaxForce()`
`PropertyMode`	`getMaxForceMode()`
`double`	`getOptFibreLength()`
`PropertyMode`	`getOptFibreLengthMode()`
`double`	`getPennationAngle()`
`PropertyMode`	`getPennationAngleMode()`
`double`	`getTendonSlackLength()`
`PropertyMode`	`getTendonSlackLengthMode()`
`boolean`	`isDFdldotZero()` Returns true if computeDFdldot() always returns zero.
`void`	`scaleDistance(double s)` Scales all distance coordinates.
`void`	`scaleMass(double s)` Scales all mass units.
`void`	`setDamping(double d)`
`void`	`setDampingMode(PropertyMode mode)`
`void`	`setForceScaling(double fScaling)`
`void`	`setForceScalingMode(PropertyMode mode)`
`void`	`setMaxForce(double maxF)`
`void`	`setMaxForceMode(PropertyMode mode)`
`void`	`setOptFibreLength(double lopt)`
`void`	`setOptFibreLengthMode(PropertyMode mode)`
`void`	`setPennationAngle(double maxF)`
`void`	`setPennationAngleMode(PropertyMode mode)`
`void`	`setTendonSlackLength(double maxF)`
`void`	`setTendonSlackLengthMode(PropertyMode mode)`

Methods inherited from class artisynth.core.materials.AxialMaterial
equals, getSubClasses

Methods inherited from class artisynth.core.materials.MaterialBase
advanceState, createStateObject, getProperty, getPropertyHost, getPropertyInfo, hasProperty, hasState, hasSymmetricTangent, isWritable, postscan, scan, setPropertyHost, setPropertyInfo, symmetryOrStateChanged, updateMaterial, write, writeItems

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_OPT_FIBRE_LENGTH
```
public static double DEFAULT_OPT_FIBRE_LENGTH
```
  - DEFAULT_MAX_FORCE
```
public static double DEFAULT_MAX_FORCE
```
  - DEFAULT_TENDON_SLACK_LENGTH
```
public static double DEFAULT_TENDON_SLACK_LENGTH
```
  - DEFAULT_PENNATION_ANGLE
```
public static double DEFAULT_PENNATION_ANGLE
```
  - DEFAULT_DAMPING
```
public static double DEFAULT_DAMPING
```
  - DEFAULT_FORCE_SCALING
```
public static double DEFAULT_FORCE_SCALING
```
  - activForceLengthCurve
```
public static CubicHermiteSpline1d activForceLengthCurve
```
  - passivForceLengthCurve
```
public static CubicHermiteSpline1d passivForceLengthCurve
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - Hill3ElemMuscleRigidTendon
```
public Hill3ElemMuscleRigidTendon()
```
  - Hill3ElemMuscleRigidTendon
```
public Hill3ElemMuscleRigidTendon(double maxIsoForce,
                                  double optimalFibreLen,
                                  double tendonSlackLen,
                                  double penAngle)
```
- Method Detail
  - getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
    Description copied from interface: HasProperties
    
    Returns a list giving static information about all properties exported by this object.
    
    Specified by:
    
    getAllPropertyInfo in interface HasProperties
    
    Overrides:
    
    getAllPropertyInfo in class MaterialBase
    
    Returns:
    
    static information for all exported properties
  - getOptFibreLength
```
public double getOptFibreLength()
```
  - setOptFibreLength
```
public void setOptFibreLength(double lopt)
```
  - getOptFibreLengthMode
```
public PropertyMode getOptFibreLengthMode()
```
  - setOptFibreLengthMode
```
public void setOptFibreLengthMode(PropertyMode mode)
```
  - getMaxForce
```
public double getMaxForce()
```
  - setMaxForce
```
public void setMaxForce(double maxF)
```
  - getMaxForceMode
```
public PropertyMode getMaxForceMode()
```
  - setMaxForceMode
```
public void setMaxForceMode(PropertyMode mode)
```
  - getTendonSlackLength
```
public double getTendonSlackLength()
```
  - setTendonSlackLength
```
public void setTendonSlackLength(double maxF)
```
  - getTendonSlackLengthMode
```
public PropertyMode getTendonSlackLengthMode()
```
  - setTendonSlackLengthMode
```
public void setTendonSlackLengthMode(PropertyMode mode)
```
  - getPennationAngle
```
public double getPennationAngle()
```
  - setPennationAngle
```
public void setPennationAngle(double maxF)
```
  - getPennationAngleMode
```
public PropertyMode getPennationAngleMode()
```
  - setPennationAngleMode
```
public void setPennationAngleMode(PropertyMode mode)
```
  - getDamping
```
public double getDamping()
```
  - setDamping
```
public void setDamping(double d)
```
  - getDampingMode
```
public PropertyMode getDampingMode()
```
  - setDampingMode
```
public void setDampingMode(PropertyMode mode)
```
  - getForceScaling
```
public double getForceScaling()
```
  - setForceScaling
```
public void setForceScaling(double fScaling)
```
  - getForceScalingMode
```
public PropertyMode getForceScalingMode()
```
  - setForceScalingMode
```
public void setForceScalingMode(PropertyMode mode)
```
  - computeF
```
public double computeF(double l,
                       double ldot,
                       double l0,
                       double excitation)
```
    Description copied from class: AxialMaterial
    
    Computes and returns the axial spring tension, as a function of length, length time derivative, rest length, and excitation.
    
    Specified by:
    
    computeF in class AxialMaterial
    
    Parameters:
    
    l - spring length
    
    ldot - spring length time derivative
    
    l0 - spring rest length
    
    excitation - excitation value (varying from 0 to 1)
    
    Returns:
    
    spring tension
  - computeDFdl
```
public double computeDFdl(double l,
                          double ldot,
                          double l0,
                          double excitation)
```
    Description copied from class: AxialMaterial
    
    Computes and returns the derivative of the axial spring tension with respect to the length.
    
    Specified by:
    
    computeDFdl in class AxialMaterial
    
    Parameters:
    
    l - spring length
    
    ldot - spring length time derivative
    
    l0 - spring rest length
    
    excitation - excitation value (varying from 0 to 1)
    
    Returns:
    
    tension derivative with respect to length
  - computeDFdldot
```
public double computeDFdldot(double l,
                             double ldot,
                             double l0,
                             double excitation)
```
    Description copied from class: AxialMaterial
    
    Computes and returns the derivative of the axial spring tension with respect to the length time derivative.
    
    Specified by:
    
    computeDFdldot in class AxialMaterial
    
    Parameters:
    
    l - spring length
    
    ldot - spring length time derivative
    
    l0 - spring rest length
    
    excitation - excitation value (varying from 0 to 1)
    
    Returns:
    
    tension derivative with respect to length time derivative
  - isDFdldotZero
```
public boolean isDFdldotZero()
```
    Description copied from class: AxialMaterial
    
    Returns true if computeDFdldot() always returns zero. For a linear spring, this simply means the damping is zero. When dFdldot is always 0, then stiffness matrix will be symmetric.
    
    Specified by:
    
    isDFdldotZero in class AxialMaterial
  - equals
```
public boolean equals(AxialMaterial mat)
```
    Overrides:
    
    equals in class AxialMaterial
  - clone
```
public Hill3ElemMuscleRigidTendon clone()
```
    Description copied from interface: CompositeProperty
    
    Returns a clone of this composite property.
    
    Specified by:
    
    clone in interface CompositeProperty
    
    Specified by:
    
    clone in interface Clonable
    
    Overrides:
    
    clone in class AxialMaterial
    
    Returns:
    
    clone of this property
  - scaleDistance
```
public void scaleDistance(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all distance coordinates.
    
    Specified by:
    
    scaleDistance in interface ScalableUnits
    
    Overrides:
    
    scaleDistance in class MaterialBase
    
    Parameters:
    
    s - scaling factor
  - scaleMass
```
public void scaleMass(double s)
```
    Description copied from interface: ScalableUnits
    
    Scales all mass units.
    
    Specified by:
    
    scaleMass in interface ScalableUnits
    
    Overrides:
    
    scaleMass in class MaterialBase
    
    Parameters:
    
    s - scaling factor

Class Hill3ElemMuscleRigidTendon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.materials.AxialMaterial

Methods inherited from class artisynth.core.materials.MaterialBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_OPT_FIBRE_LENGTH

DEFAULT_MAX_FORCE

DEFAULT_TENDON_SLACK_LENGTH

DEFAULT_PENNATION_ANGLE

DEFAULT_DAMPING

DEFAULT_FORCE_SCALING

activForceLengthCurve

passivForceLengthCurve

myProps

Constructor Detail

Hill3ElemMuscleRigidTendon

Hill3ElemMuscleRigidTendon

Method Detail

getAllPropertyInfo

getOptFibreLength

setOptFibreLength

getOptFibreLengthMode

setOptFibreLengthMode

getMaxForce

setMaxForce

getMaxForceMode

setMaxForceMode

getTendonSlackLength

setTendonSlackLength

getTendonSlackLengthMode

setTendonSlackLengthMode

getPennationAngle

setPennationAngle

getPennationAngleMode

setPennationAngleMode

getDamping

setDamping

getDampingMode

setDampingMode

getForceScaling

setForceScaling

getForceScalingMode

setForceScalingMode

computeF

computeDFdl

computeDFdldot

isDFdldotZero

equals

clone

scaleDistance

scaleMass